Когда Swagger встретил YApi, он мгновенно стал выше!

Spring Boot Java
Когда Swagger встретил YApi, он мгновенно стал выше!

Адрес фактического центра электронной коммерции SpringBoot (40k+star):GitHub.com/macro-positive/…

Резюме

Swagger часто жалуются на то, что интерфейс некрасивый, а функция недостаточно мощная.На самом деле, есть много инструментов, которые можно использовать в сочетании со Swagger, и после объединения им станет очень легко пользоваться. Я написал статью раньше«Как сломать уродливый интерфейс и слабую функцию Swagger? Улучшено с Postman, это потрясающе! 》, друг оставил сообщение о том, что YApi тоже очень полезен. Я недавно испытал YApi и нашел его действительно хорошим, всем рекомендую!

Введение в ЯПи

YApi — это эффективная, простая в использовании и мощная платформа управления API, целью которой является предоставление более элегантных услуг по управлению интерфейсом для разработчиков, продуктов и тестировщиков. YApi накопил 18K+ звезд на Github и имеет отличный интерактивный опыт.YApi не только предоставляет общие функции управления интерфейсом, но также предоставляет такие функции, как управление разрешениями, фиктивные данные и импорт данных Swagger.Короче говоря, функции очень мощные!

Установить

Подготовка окружающей среды

Чтобы развернуть YApi локально, вам нужно сначала установить nodejs и MongoDB, давайте сначала установим их.

Установите япи-кли

yapi-cliЭто инструмент установки, официально предоставленный YApi, который может развертывать службы YApi через визуальный интерфейс, что очень удобно!

  • Установить с помощью команды npmyapi-cli:
npm install -g yapi-cli --registry https://registry.npm.taobao.org
  • После успешной установки вывод консоли выглядит следующим образом:

  • Используйте после успешной установкиyapi serverКоманда для запуска визуального интерфейса развертывания YApi.
yapi server

Установить YApi

  • Установите службу YApi через визуальный интерфейс развертывания и получите доступ к адресу:http://localhost:9090

  • После завершения установки будет выведена следующая информация, запрашивающая пароль учетной записи администратора по умолчанию и адрес доступа YApi;

  • Войдите в каталог установки YApi и используйте команду узла для запуска службы YApi:
node vendors/server/app.js
  • После успешного запуска в консоль выводится следующая информация:

  • Доступ к Yapi через страницу, пароль учетной записи по умолчаниюadmin@admin.com:ymfe.org,адрес:http://localhost:3000

использовать

Импорт данных из Swagger

  • После успешного входа в систему с учетной записью администратора сначала создайтеmall-tiny-groupгруппа;

  • После успешного создания группы щелкните под группой创建项目,Добавить кmall-tiny-swaggerпроект;

  • После этого начинаем нашу предыдущуюmall-tiny-swaggerProject, адрес доступа к документу интерфейса Swagger после успешного запуска:http://localhost:8088/swagger-ui/

  • Выберите хороший YApi数据管理настройте путь API-документов Swagger, а затем импортируйте данные;

  • На данный момент интерфейс API в Swagger успешно импортирован в YApi, нажмите接口вкладку для просмотра всех импортированных интерфейсов.

Управление интерфейсом

  • Открытым添加商品Взгляните на интерфейс, вы можете увидеть очень полную информацию о документации интерфейса, доступны комментарии;

  • Давайте попробуем функцию работы интерфейса, мы обнаружим, что адрес запроса интерфейса по умолчанию не соответствует нашим требованиям, нам нужно环境配置установить;

  • Поскольку это междоменный запрос, в браузере Chrome необходимо установить подключаемый модуль междоменного запроса. Адрес загрузки:GitHub.com/YM Fe/кросс-…

  • Поскольку к некоторым нашим интерфейсам можно получить доступ, только добавив токен в заголовок запроса, мы сначала вызываем интерфейс входа в систему, чтобы получить токен;

  • позже设置->环境配置Добавьте заголовок авторизации в;

  • Вызовите интерфейс, который необходимо снова войти в систему, и данные могут быть получены нормально.Хотя возвращаемые данные отформатированы, функция свертывания отсутствует.Если данные слишком длинные, это будет выглядеть не очень хорошо;

Мок-функция

  • Когда мы вызываем интерфейс POST для отправки данных JSON, данные JSON макета по умолчанию не соответствуют нашим требованиям;

  • через интерфейсную информацию编辑->高级设置модифицировать;

  • Мы можем обнаружить, что в информации о каждом интерфейсе есть фиктивный адрес.Когда наш фоновый интерфейс имеет определенный формат, но не был реализован, внешний интерфейс может использовать этот адрес для фиктивных данных для отладки;

  • Некоторые тестовые данные можно получить, вызвав фиктивный адрес, а возврат значения данных можно изменить с помощью указанных выше фиктивных настроек;

Автоматическая синхронизация от Swagger

  • Когда наш интерфейс будет изменен, как синхронизировать документ API, мы можем передать设置->Swagger自动同步Чтобы включить функцию автоматической синхронизации, можно выбрать один из трех режимов синхронизации данных;

управление полномочиями

Что делать, если новый участник присоединяется и ему нужно проверить документацию по API?

  • Во-первых, вы можете зарегистрировать учетную запись участника через интерфейс регистрации, где учетная записьtest@qq.com:123456;

  • Затем войдите в систему с учетной записью администратора, а затем пройдите成员列表->添加成员добавьте пользователя в соответствующую группу;

  • Наконец, войдите в систему с учетной записью участника для доступа к соответствующей документации API.

Суммировать

YApi в сочетании с Swagger — это действительно мощно! При использовании Postman в сочетании с Swagger ранее были решены проблемы с просмотром документов и автоматической синхронизацией, а для обеспечения безопасности доступа к нашим документам через API также предусмотрена функция управления разрешениями. Когда формат данных API определен, функция Mock позволяет внешнему интерфейсу отлаживать интерфейс без необходимости внутренней реализации. Однако поддержка формата JSON слабовата, было бы лучше, если бы данные JSON можно было сворачивать и отображать!

использованная литература

Официальная документация:привет, Шон1025.GitHub.IO/yuppy/doc ume…

Адрес исходного кода проекта

GitHub.com/macro-positive/…

Эта статьяGitHubGitHub.com/macro-positive/…Записано, приветствую всех на Star!

Категории