Documentação da API REST do Construtor de API de Dados com Swagger/OpenAPI
A especificação do OpenAPI é um padrão independente de linguagem de programação para documentar APIs HTTP. O Construtor de API de Dados dá suporte ao padrão OpenAPI com a capacidade de:
- Gere informações sobre todas as entidades definidas pela configuração de runtime que estão habilitadas para REST.
- Compile as informações em um formato que corresponda ao esquema OpenAPI.
- Expõe o esquema OpenAPI gerado por meio de uma interface do usuário visual (Swagger) ou um arquivo serializado.
Documento de descrição do OpenAPI
O Construtor de API de Dados gera um documento de descrição do OpenAPI usando a configuração de runtime fornecida e os metadados de objeto de banco de dados para cada entidade habilitada para REST definida. O arquivo de esquema é gerado usando a funcionalidade fornecida pelo SDK do OpenAPI.NET. Atualmente, o arquivo de esquema é gerado em adesão à Especificação do OpenAPI v3.0.1 formatada como JSON.
O documento de descrição do OpenAPI pode ser buscado no Construtor de API de Dados no caminho:
GET /{rest-path}/openapi
Observação
Por padrão, o rest-path valor é api e é configurável. Para obter mais informações, consulte Configuração REST
SwaggerUI
A Interface do usuário do Swagger oferece uma interface do usuário baseada na Web que conta com informações sobre o serviço, usando a especificação do OpenAPI gerada.
No Development modo , o Construtor de API de Dados permite exibir o documento de descrição do OpenAPI gerado de um ponto de extremidade dedicado:
GET /swagger
O ponto de extremidade "Swagger" não está aninhado rest-path no para evitar conflitos de nomenclatura com entidades configuradas para runtime.