Я использовал много инструментов для документирования API и написал много статей на эту тему за эти годы.
哪种API文档工具更好用Эта тема всегда волновала всех. Сегодня я разобрал 7 инструментов документации API, которые я использовал.Каждый из них имеет подробное руководство по использованию.Каждый из них должен вам понравиться!
Адрес фактического центра электронной коммерции SpringBoot (50k+star):GitHub.com/macro-positive/…
Swagger
Swagger — очень популярный инструмент документации API, который может помочь вам упростить разработку документации API и значительно повысить эффективность разработки.mallОн используется в проекте.
Обычно мы используем Swagger в сочетании со SpringBoot, используя инструменты, предоставляемые Springfox. С помощью этого инструмента можно автоматически генерировать документацию по API на основе аннотаций, а также выполнять отладку интерфейса по созданной документации.
Поскольку документация API обновляется по мере запуска проекта, гарантируется характер документации API в режиме реального времени! Springfox официально предоставляет нам Starter, который очень удобно интегрировать.Если вы все еще вручную интегрируете Swagger в проект SpringBoot, вы можете взглянуть«Все еще интегрируете Swagger вручную? Swagger официальный Starter действительно ароматный! 》.
адрес проекта:GitHub.com/spring fox/ это…
Knife4j
Несмотря на то, что Swagger очень прост в использовании, у него есть недостатки: не красивый интерфейс и слабая функция отладки API, например, параметры запроса не проверяются, и его нельзя свернуть при возврате кучи JSON-данных. Итак, на основе Swagger есть несколько усовершенствованных инструментов.
Knife4j — это расширенная реализация пользовательского интерфейса springfox-swagger, которая предоставляет разработчикам Java краткую и мощную документацию по интерфейсу при использовании Swagger. Knife4j полностью повторяет использование в springfox-swagger и вносит улучшения на этой основе.Если вы использовали Swagger, вы можете легко переключиться на Knife4j.
Использование Knife4j похоже на изменение нового скина для Swagger, и он мгновенно становится выше."Сменил новый скин для Swagger, и мгновенно стал выше! 》.
Если ваш проект является микросервисным, вы можете использовать Knife4j для объединения документов всех сервисов.«Микросервисы агрегируют документы Swagger, эта волна операций действительно ароматна! 》.
адрес проекта:GitHub.com/Onomin/Так называемый…
Postman
Поскольку возможности отладки интерфейса Swagger относительно слабы, использование Postman для отладки является хорошим решением.
Postman — это инструмент отладки интерфейса API, который можно использовать для простого тестирования интерфейса, а обслуживающий персонал может экспортировать свои собственные результаты отладки, что удобно для отладки внешнего персонала.«Почтальон: инструмент отладки интерфейса API».
Конечно, в Postman также можно просматривать документы API, но функция слабовата, поэтому есть популярная комбинация Swagger+Postman, подробнее см.«Как сломать уродливый интерфейс и слабую функцию Swagger? Улучшено с Postman, это потрясающе! 》.
Официальный сайт:www.postman.com/
YApi
В дополнение к таким инструментам, как Knife4j, которые расширяют возможности Swagger, существует также класс инструментов, обладающих функцией управления документами API, которые могут быть развернуты независимо и могут быть подключены к Swagger, который является более мощным и также может называться API. Платформа управления документами.
Таким инструментом является YApi.YApi — это эффективная, простая в использовании и мощная платформа управления API, целью которой является предоставление более элегантных услуг по управлению интерфейсом для разработчиков, продуктов и тестировщиков. YApi накопил 18K+ звезд на Github и имеет отличный интерактивный опыт.YApi не только предоставляет общие функции управления интерфейсом, но также предоставляет такие функции, как управление разрешениями, фиктивные данные и импорт данных Swagger.Короче говоря, функции очень мощные!
Конкретное использование YApi может относиться к«Когда Swagger встречает YApi, он мгновенно становится выше! 》.
адрес проекта:github.com/YMFE/yapi
smart-doc
Swagger должен генерировать документы API с помощью собственных аннотаций. Код немного навязчив. Если вы не хотите вторжений, попробуйтеsmart-doc.
smart-docЭто инструмент генерации документов API, который не требует дополнительных операций.Пока вы пишете комментарии к коду стандартным способом, вы можете создавать документы API. В то же время он может напрямую генерировать файлы отладки Postman и импортировать Postman для отладки одним щелчком мыши, что очень просто в использовании!
smart-docКак и возможность отладки интерфейса Swagger, она относительно слаба и должна использоваться с Postman.«Все еще пользуетесь Swagger? Попробуйте этот инструмент для создания документов API без аннотаций, который идеально подходит для Postman! 》.
адрес проекта:git ee.com/smart-doc — он…
Torna
Еще один независимо развертываемый инструмент управления документами API, который может создать платформу управления документами API. Не только поддерживает импорт Swagger, но также поддерживает такие импорты, как Postman и OpenApi.
Torna — это решение для документации интерфейса корпоративного уровня, которое можно использовать с Swagger.«Когда Сваггер встречает Торну, он мгновенно становится выше! 》. Он имеет следующие функции:
- Управление документами: поддержка добавления, удаления, модификации и проверки документов интерфейса, отладки интерфейса, управления словарем, а также функций импорта и экспорта;
- Управление разрешениями: он поддерживает управление разрешениями документов интерфейса и одновременно имеет три роли посетителя, разработчика и администратора;
- Двойной режим: исходный двойной режим, режим управления можно использовать для редактирования содержимого документа, режим просмотра предназначен исключительно для просмотра документа, а интерфейс не имеет помех от других элементов.
адрес проекта:git ee.com/ все подставь меня...
Apifox
Онлайн-инструмент управления документами API, который можно использовать со Swagger, с мощными функциями и классным интерфейсом!
Позиционирование ApifoxPostman + Swagger + Mock + JMeter, с управлением документами API, отладкой API, макетом API, автоматическим тестированием API и другими функциями. Проблемы синхронизации данных, для решения которых ранее использовалось несколько инструментов, можно решить с помощью одного инструмента. Эффективно, своевременно и точно!
Для конкретного использования см.:«Замените Почтальона + Развязность! Этот артефакт мощнее и имеет более крутой интерфейс! 》.
Официальный сайт:www.apifox.cn/
Суммировать
В этой статье мы разобрали 7 инструментов создания документов API + управления, которые использовались ранее.Если вы только начинаете использовать инструменты документов API, правильно использовать Swagger! Если вы используете Swagger и хотите использовать лучший инструмент документации API, рассмотрите возможность использования Swagger с Knife4j, YApi или Torna. Если вы не возражаете против использования онлайн-инструмента управления документами API, вы можете использовать Apifox, который является более мощным.
Эта статьяGitHubGitHub.com/macro-positive/…Он был записан, приветствую всех на Star!