OpenAPI na criação de API de dados

A especificação OpenAPI é um padrão independente de linguagem para documentar APIs HTTP. O construtor de API de dados suporta OpenAPI por:

• Gerando metadados para todas as entidades habilitadas para REST definidas na configuração de tempo de execução
• 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 da OpenAPI

O construtor de API de dados gera um documento de descrição OpenAPI usando a configuração de tempo de execução e os metadados do banco de dados para cada entidade habilitada para REST.

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

Você pode acessar o documento OpenAPI em:

GET /{rest-path}/openapi

[! NOTA] Por padrão, o rest-path é api. Este valor é configurável. Consulte Configuração REST para obter detalhes.

Interface do usuário do Swagger

A interface do usuário do Swagger fornece uma visão interativa e baseada na Web da API com base no esquema OpenAPI.

No Development modo, o construtor de API de dados expõe a interface do usuário do Swagger em:

GET /swagger

Este ponto de extremidade não está aninhado sob o rest-path para evitar conflitos com entidades definidas pelo usuário.