Documentación de la API REST de Data API Builder con Swagger/OpenAPI
La especificación OpenAPI es un estándar independiente del lenguaje de programación para documentar las API HTTP. Data API Builder admite el estándar OpenAPI con su capacidad para:
- Genere información sobre todas las entidades definidas por la configuración en tiempo de ejecución habilitadas para REST.
- Compile la información en un formato que coincida con el esquema de OpenAPI.
- Expone el esquema openAPI generado a través de una interfaz de usuario visual (Swagger) o un archivo serializado.
Documento de descripción de OpenAPI
Data API Builder genera un documento de descripción de OpenAPI mediante la configuración en tiempo de ejecución proporcionada y los metadatos del objeto de base de datos para cada entidad habilitada para REST definida. El archivo de esquema se genera mediante la funcionalidad proporcionada por el SDK de OpenAPI.NET. Actualmente, el archivo de esquema se genera al cumplir la especificación openAPI v3.0.1 con formato JSON.
El documento de descripción de OpenAPI se puede capturar desde data API Builder desde la ruta de acceso:
GET /{rest-path}/openapi
Nota
De forma predeterminada, el rest-path valor es api y es configurable. Para más información, consulte Configuración de REST.
SwaggerUI
La interfaz de usuario de OpenAPI es una interfaz de usuario basada en Internet que proporciona información sobre el servicio por medio de la especificación de Swagger generada.
En Development modo, Data API Builder permite ver el documento de descripción de OpenAPI generado desde un punto de conexión dedicado:
GET /swagger
El punto de conexión "Swagger" no está anidado bajo para rest-path evitar conflictos de nomenclatura con entidades configuradas en tiempo de ejecución.