Поделиться через

Документация по REST API построителя данных с помощью Swagger и OpenAPI

  • Статья

Спецификация OpenAPI — это не зависящий от языка программирования стандарт для документирования API HTTP. Построитель API данных поддерживает стандарт OpenAPI с его возможностью:

  • Создание сведений обо всех определенных сущностях конфигурации среды выполнения, которые включены в REST.
  • Компилируйте сведения в формат, соответствующий схеме OpenAPI.
  • Предоставляет созданную схему OpenAPI с помощью визуального интерфейса (Swagger) или сериализованного файла.

Документ описания OpenAPI

Построитель API данных создает документ описания OpenAPI, используя предоставленную конфигурацию среды выполнения и метаданные объекта базы данных для каждой определенной сущности с поддержкой REST. Файл схемы создается с помощью функций, предоставляемых пакетом SDK для OpenAPI.NET. В настоящее время файл схемы создается в соответствии со спецификацией OpenAPI версии 3.0.1 в формате JSON.

Документ описания OpenAPI можно получить из построителя API данных по пути:

GET /{rest-path}/openapi

Примечание

По умолчанию rest-path значение равно api и настраивается. Дополнительные сведения см. в разделе Конфигурация REST.

SwaggerUI

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

В Development режиме построитель API данных позволяет просматривать созданный документ описания OpenAPI из выделенной конечной точки:

GET /swagger

Конечная точка Swagger не вложена rest-path в , чтобы избежать конфликтов именования с настроенными в среде выполнения сущностями.

См. также