Как back-end разработчику, нам часто нужно поддерживать документы API, отлаживать интерфейсы API, а иногда и фиктивные данные. Хотя Postman очень полезен как инструмент отладки интерфейса, он не подходит для ведения документации по API. Сегодня я хотел бы порекомендовать более мощный инструмент Apifox, которого достаточно для удовлетворения наших различных потребностей в API, надеюсь, он будет вам полезен!
Адрес фактического проекта электронной коммерции SpringBoot (50k+star):GitHub.com/macro-positive/…
Об Апифоксе
Позиционирование ApifoxPostman + Swagger + Mock + JMeter, с управлением документами API, отладкой API, макетом API, автоматическим тестированием API и другими функциями. Проблемы синхронизации данных, для решения которых ранее использовалось несколько инструментов, можно решить с помощью одного инструмента. Эффективно, своевременно и точно!
Установить
- Установка Apifox очень удобна, просто скачайте установочный пакет, распакуйте его и установите.Адрес для скачивания:www.apifox.cn/
- Чиновник очень любезно предоставил
示例项目, вы можете испытать функции Apifox напрямую, открыв его, и интерфейс по-прежнему очень красивый;
- Если мы используем его сами, нам нужно сначала
新建团队, чтобы облегчить сотрудничество между членами команды;
- потом в команду
新建项目, после успешного создания нового мы можем начать использовать мощные функции Apifox!
Импорт документации API
Функция импорта документов API Apifox очень мощная и поддерживает импорт до 20 инструментов, включая Swagger, Postman, YApi, ShowDoc и т. д. Далее мы передаем перед использованием
mall-tiny-swaggerИнтерфейс в проекте, чтобы испытать его функцию импорта!
- Сначала мы выбираем
新建接口кнопка, выберите导入;
- Затем откройте интерфейс импорта, выберите
Swagger->URL导入, введите URL-адрес данных Swagger;
- покажет при импорте
导入预览, показывая接口и数据模型, Apifox преобразует класс сущности, возвращаемый нашим интерфейсом, в модель данных для повторного использования;
- После успешного импорта эффект интерфейса выглядит следующим образом: Apifox различает просмотр документов и изменение документов, что нам удобно для управления документами интерфейса.
Управление интерфейсом
Хотя документация по интерфейсу, импортированная из Swagger, очень подробная, чтобы испытать более мощные функции Apifox, нам иногда нужно редактировать информацию об интерфейсе.
дизайн интерфейса
- Взгляните на интерфейс параметров запроса Apifox, который очень подробный!
- Давайте взглянем на интерфейс возвращаемых результатов Apifox, который поддерживает свертывание, чего нет во многих инструментах;
- Взгляните на Apifox
修改文档Интерфейс, поддерживающий добавление состояний, групп и меток.
Отладка интерфейса
Давайте испытаем функцию отладки Apifox, которая более мощная, чем Postman!
- Когда мы разрабатываем интерфейсы, нам часто нужно разделить разные среды, Apifox по умолчанию разделяет их за нас.
测试环境,正式环境,Mock服务, этих трех в принципе достаточно;
- Перед отладкой интерфейса мы должны сначала установить соответствующую среду
前置URL, например, здесь мы устанавливаем测试环境из;
- В Apifox мы можем использовать
接口用例Для отладки нашего интерфейса вариант использования интерфейса может сохранять введенные нами параметры для последующего тестирования;
- Apifox поддерживает пользовательские операции до и после вызовов интерфейса, например, мы можем
后置操作добавить断言, вернуться в результатеcode等于200Указывает, что операция прошла успешно;
- В это время мы вводим неверный пароль для вызова следующего интерфейса, а утверждение прямо подскажет нам, что результат не соответствует ожиданиям;
- Некоторые интерфейсы, которые нам нужно передать
Authorizationперейти к доступу;
- Этот доступ мы можем получить через
环境变量Для достижения сначала добавьте в интерфейс входа в систему后置操作,выберите提取变量, извлечь возвращенный токен в переменную средыAUTH_TOKENсередина;
- Затем измените документ интерфейса в
HeaderСредние настройки должны быть переданыAuthorizationголова;
- следующий в
接口用例использовать через выражения вAuthorizationЗаголовок обычно может получить доступ к интерфейсу, который требует аутентификации входа.
использовать скрипт
Настройка Apifox
前置操作и后置操作Очень мощный, не только поддерживает простой断言и提取变量, а также поддерживает написание JS-скриптов.
- Например, прежде чем мы решим, что операция прошла успешно, утвердите
code等于200Этого можно добиться с помощью такого скрипта;
- В это время мы вводим неверный пароль для вызова следующего интерфейса, и ассертинг прямо подскажет нам, что результат не соответствует ожиданиям.
Имитация данных
Когда наш внутренний интерфейс еще не разработан, а для разработки внешнего интерфейса нужны данные, мы часто можем предоставить данные через Mock.Функция данных Apifox Mock также очень эффективна.
- Apifox утверждает, что может идентифицировать имена полей в вашей модели данных.
智能Mock, давайте посмотрим на его правила;
- На самом деле правила Mock по умолчанию иногда не идеальны.Например, давайте взглянем на его Mock-данные;
- В этот момент мы можем
数据模型Модификация в Mock может сделать данные Mock более удобными для пользователя, например, мы можем установить различные состояния для типов перечисления;
- Вы также можете передать поле логотипа через
@imageЭтот метод установлен на тип изображения;
- После сброса он более гуманизирован;
- Затем просто измените среду на
Mock服务Вы можете вызвать интерфейс Mock data!
Управление тестированием
Apifox поддерживает не только отладку интерфейса, но и создание тестовых случаев для пакетного тестирования и тестирования производительности.
- Сначала мы можем
测试管理Создавайте тестовые случаи в;
- выбирать после
从接口用例导入, выберите вариант использования интерфейса для импорта;
- хорошо выбирай
运行环境После этого нажмите «Выполнить», чтобы выполнить пакетное тестирование;
- После завершения теста можно отобразить отчет о тестировании;
- Если вы хотите выполнить тест производительности, выберите OK в тестовом интерфейсе.
线程数Ты сможешь;
- После прохождения теста его можно пройти
导出报告для просмотра более подробной информации отчета.
Настройки темы
личная привычка暗色Тема, Apifox также может выбрать亮色Тему и основной цвет можно переключать прямо в настройках.
Суммировать
Apifox действительно красивый и мощный инструмент интерфейса API. Он в основном имеет некоторые функции отладки интерфейса Postman, а также интегрирует интерфейс управления документами, макет данных, автоматическое тестирование и другие функции.Настоятельно рекомендуется попробовать!
использованная литература
Официальная документация:www.apifox.cn/help/
Адрес исходного кода проекта
Эта статьяGitHubGitHub.com/macro-positive/…Записано, приветствую всех на Star!