Documentação da API REST do construtor de API de Dados com o Swagger/OpenAPI
A especificação OpenAPI é um padrão agnóstico de linguagem de programação para documentar APIs HTTP. O construtor de API de Dados suporta a norma OpenAPI com a capacidade de:
- Gerar informações sobre todas as entidades definidas pela configuração do runtime que estão ativadas para REST.
- Compile as informações num formato que corresponda ao esquema OpenAPI.
- Expõe o esquema OpenAPI gerado através de uma IU visual (Swagger) ou de um ficheiro serializado.
Documento de descrição openAPI
O construtor de API de Dados gera um documento de descrição openAPI com a configuração de runtime fornecida e os metadados de objetos de base de dados para cada entidade ativada para REST definida. O ficheiro de esquema é gerado com a funcionalidade fornecida pelo SDK OpenAPI.NET. Atualmente, o ficheiro de esquema é gerado em conformidade com a Especificação openAPI v3.0.1 formatada como JSON.
O documento de descrição openAPI pode ser obtido a partir do construtor de API de Dados a partir do caminho:
GET /{rest-path}/openapi
Nota
Por predefinição, o rest-path valor é api e é configurável. Para obter mais informações, veja Configuração REST
SwaggerUI
A IU do Swagger oferece uma IU baseada na Web que fornece informações sobre o serviço através da especificação openAPI gerada.
No Development modo, o construtor de API de Dados permite ver o documento de descrição openAPI gerado a partir de um ponto final dedicado:
GET /swagger
O ponto final "Swagger" não está aninhado rest-path no para evitar conflitos de nomenclatura com entidades configuradas com runtime.