OpenAPI.Tools

Оставайтесь в курсе созданного сообществом списка современных и высококачественных инструментов для OpenAPI.

Есть ли инструмент, который, по вашему мнению, должен быть в этом списке? Отправьте Pull Request на GitHub по адресу https://github.com/apisyouwonthate/openapi.tools

Вот краткий обзор типов инструментов, организованных по категориям, чтобы вы могли перейти к интересующему вас разделу:

• Auto Generators (Автогенераторы): Инструменты, которые берут ваш код и превращают его в документ OpenAPI Specification.

• Converters (Конвертеры): Различные инструменты для конвертации в и из форматов описания API, включая OpenAPI.

• Data Validators (Проверщики данных): Проверяют, соответствуют ли запросы и ответы API описанию API.

• Description Validators (Проверщики описания): Проверяют ваше описание API на соответствие стандарту OpenAPI.

• Documentation (Документация): Преобразуют описание API в HTML (или, возможно, PDF), чтобы менее технически подкованные люди могли разобраться в работе с API.

• DSL (Язык описания предметной области): Писать YAML вручную не всегда удовольствие, и, возможно, вы не хотите использовать графический интерфейс. Так что используйте DSL для написания OpenAPI на выбранном вами языке.

• Gateways (Шлюзы): Шлюзы API и связанные инструменты, которые имеют встроенную поддержку OpenAPI.

• GUI Editors (Графические редакторы): Визуальные редакторы помогают вам проектировать API без необходимости запоминать всю спецификацию OpenAPI.

• Learning (Обучение): Независимо от того, пытаетесь ли вы получить документацию для API сторонних разработчиков на основе трафика или же пытаетесь перейти к разработке с учетом дизайна в организации, где OpenAPI отсутствует, обучение может помочь вам двигать вашу спецификацию API вперед и поддерживать ее в актуальном состоянии.

• Miscellaneous (Прочее): Любые другие инструменты, работающие с OpenAPI, но не имеющие достаточно функциональности для собственной категории.

• Mock Servers (Мок-серверы): Фиктивные серверы, которые используют документ описания как входные данные, затем маршрутизируют входящие HTTP-запросы к примерным ответам или динамически генерируют примеры.

• Monitoring (Мониторинг): Инструменты мониторинга. Отслеживание работоспособности.

• Parsers (Парсеры): Загружают и считывают описания OpenAPI, чтобы вы могли работать с ними программно.

• SDK Generators (Генераторы SDK): Генерируют код, который можно передать потребителям, чтобы помочь им избежать взаимодействия на уровне HTTP.

• Security (Безопасность): Путем изучения вашего описания OpenAPI некоторые инструменты могут обнаруживать потенциальные векторы атак, которые вы могли бы упустить из виду.

• Server Implementations (Реализации сервера): Легко создавайте и реализуйте ресурсы и маршруты для ваших API.

• Testing (Тестирование): Быстро выполняйте запросы к API и проверяйте ответы на лету через командную строку или графический интерфейс.

• Text Editors (Текстовые редакторы): Текстовые редакторы предоставляют визуальную обратную связь при написании OpenAPI, так что вы можете видеть, как могли бы выглядеть документация.

Если у вас есть какие-либо конкретные вопросы или интересует определенная категория инструментов, пожалуйста, дайте знать, и я с удовольствием предоставлю дополнительную информацию.

Автогенераторы

Инструменты, которые преобразуют ваш код в документацию по спецификации OpenAPI.

Эти инструменты могут быть полезными для автоматизации процесса создания документации API, особенно если у вас уже есть код, который вы хотите документировать.

Шлюзы API

API-шлюзы и связанные с ними инструменты, которые имеют интегрированную поддержку OpenAPI.

Эти инструменты предоставляют различные функции для управления и документирования API, и многие из них интегрированы с OpenAPI. Они могут быть полезными для разработчиков, которые хотят упростить и автоматизировать процесс работы с API.

Мониторинг

Инструменты мониторинга позволяют вам понимать, что происходит с вашим API.

Примечания

• ✅ означает поддержку данной версии OpenAPI.
• ❌ означает отсутствие поддержки данной версии OpenAPI.