OpenAPI в построителе API данных

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

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

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

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

Схема создается с помощью пакета SDK OpenAPI.NET и соответствует спецификации OpenAPI версии 3.0.1. Он выводится в виде документа JSON.

Вы можете получить доступ к документу OpenAPI по адресу:

GET /{rest-path}/openapi

[! ПРИМЕЧАНИЕ] По умолчанию rest-path — это api. Это значение можно настроить. Дополнительные сведения см. в конфигурации REST .

Пользовательский интерфейс Swagger

Пользовательский интерфейс Swagger предоставляет интерактивное веб-представление API на основе схемы OpenAPI.

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

GET /swagger

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