OpenAPI no construtor de APIs de dados

A especificação OpenAPI é um padrão independente de idioma para documentar APIs HTTP. O Construtor de API de Dados dá suporte ao OpenAPI por:

• Gerando metadados para todas as entidades habilitadas para REST definidas na configuração de runtime
• Compilando esses metadados em um esquema OpenAPI válido
• Expondo o esquema por meio de uma interface do usuário visual (Swagger) ou como um arquivo JSON serializado

Documento de descrição do OpenAPI

O Construtor de API de Dados gera um documento de descrição OpenAPI usando a configuração de runtime e os metadados de banco de dados para cada entidade habilitada para REST.

O esquema é criado usando o SDK do OpenAPI.NET e está em conformidade com a Especificação do OpenAPI v3.0.1. É gerado como um documento JSON.

Você pode acessar o documento OpenAPI em:

GET /{rest-path}/openapi

[! OBSERVAÇÃO] Por padrão, é rest-pathapi. Esse valor é configurável. Consulte a configuração REST para obter detalhes.

Interface do usuário do Swagger

Swagger UI fornece uma exibição interativa baseada na web da API com base no esquema OpenAPI.

No Development modo, o Data API Builder expõe o Swagger UI em:

GET /swagger

Esse endpoint não está aninhado sob o rest-path para evitar conflitos com entidades definidas pelo usuário.