Entaxy OpenAPI

Раздел с интегрированным Swagger-редактором для разработки и редактирования API.

Интерфейс OpenAPI

Раздел File

Содержит основные операции для работы со спецификацией: открытие, сохранение и скачивание.

Открыть спецификацию API

По умолчанию спецификация открывается в формате YAML. Для открытия в формате JSON ее необходимо вставить в редактор вручную.

Для открытия спецификации в редакторе можно использовать один из способов:

  • Import URL - импортировать спецификацию по URL

  • Import file - импортировать спецификацию из файловой системы

  • Open - открыть спецификацию из ресурсов платформы Entaxy

    file menu open

Кроме того, спецификацию можно открыть из раздела Ресурсы через контекстное меню 'Open in OpenAPI Editor'.

context menu openapi

Сохранить спецификацию API

Для сохранения спецификации можно использовать один из способов:

  • Download JSON - скачать спецификацию в формате JSON

  • Download YAML - скачать спецификацию в формате YAML

  • Save - сохранить спецификацию в ресурсах платформы Entaxy

  • Save as JSON - сохранить спецификацию в ресурсах платформы Entaxy в формате JSON

  • Save as YAML - сохранить спецификацию в ресурсах платформы Entaxy в формате YAML

    download file

  • Clear editor - очистить редактор

    clear editor

Раздел Edit

Содержит дополнительные действия для работы со спецификацией OpenAPI.

Конвертировать спецификацию API в формат YAML

  • Convert to YAML — конвертация текущей спецификации в формат YAML

    convert to yaml

  • Load Petstore OAS 3.0 — загрузка примера спецификации Petstore на основе OpenAPI 3.0.

Раздел Insert

Добавление элементов спецификации OpenAPI

Позволяет вставлять в спецификацию OpenAPI готовые элементы и шаблоны:

  • Add Path Item - добавление нового Path.

  • Add Operation - добавление операции (GET, POST и т.д.).

  • Add Info - добавление или редактирование блока info с метаданными спецификации (Title, Version, Description, Terms of Service).

  • Add External Documentation - добавление ссылки на внешнюю документацию (externalDocs).

  • Add Tag Declarations - добавление уникальных тегов спецификации с метаданными; порядок тегов учитывается при обработке операций.

  • Add Tag To Operation - назначение тегов операции для управления публикацией API; теги могут использоваться для логической группировки операций по ресурсам или любым другим параметрам.

  • Add Servers - добавление серверов API с указанием URL, описания и переменных сервера (значение по умолчанию, список допустимых значений и описание).

  • Add Example Response - добавление примера ответа операции с указанием кода HTTP и структуры возвращаемых данных.

    insert

Раздел Generate Client

Создание клиентских библиотек API на основе спецификации OpenAPI

Позволяет автоматически формировать клиентские библиотеки API на основе текущей спецификации OpenAPI. Поддерживаемые языки и фреймворки:

API-клиенты : “csharp”, “csharp-dotnet2”, “dart”, “go”, “java”, “javascript”, “jaxrs-cxf-client”, “kotlin-client”, “php”, “python”, “r”, “ruby”, “scala”, “swift3”, “swift4”, “swift5”, “typescript-angular”, “typescript-axios”, “typescript-fetch”“csharp”, “csharp-dotnet2”, “dart”, “go”, “java”, “javascript”, “jaxrs-cxf-client”, “kotlin-client”, “php”, “python”, “r”, “ruby”, “scala”, “swift3”, “swift4”, “swift5”, “typescript-angular”, “typescript-axios”, “typescript-fetch”.

Генераторы документации API : “dynamic-html”, “html”, “html2”, “openapi”, “openapi-yaml”.