Documentation de l’API REST du générateur d’API de données avec Swagger /OpenAPI
La spécification OpenAPI est une norme indépendante du langage de programmation pour documenter les API HTTP. Le générateur d’API de données prend en charge la norme OpenAPI avec sa capacité à :
- Générez des informations sur toutes les entités définies par la configuration du runtime qui sont activées par REST.
- Compilez les informations dans un format qui correspond au schéma OpenAPI.
- Expose le schéma OpenAPI généré via une interface utilisateur visuelle (Swagger) ou un fichier sérialisé.
Document de description OpenAPI
Le générateur d’API de données génère un document de description OpenAPI à l’aide de la configuration d’exécution fournie et des métadonnées d’objet de base de données pour chaque entité REST activée définie. Le fichier de schéma est généré à l’aide des fonctionnalités fournies par le sdk OpenAPI.NET. Actuellement, le fichier de schéma est généré conformément à la spécification OpenAPI v3.0.1 au format JSON.
Le document de description OpenAPI peut être extrait du Générateur d’API de données à partir du chemin d’accès :
GET /{rest-path}/openapi
Notes
Par défaut, la rest-path valeur est api et est configurable. Pour plus d’informations, consultez Configuration REST
SwaggerUI
L’IU Swagger est une interface utilisateur web qui fournit des informations sur le service, à l’aide de la spécification OpenAPI générée.
En Development mode, le générateur d’API de données permet d’afficher le document de description OpenAPI généré à partir d’un point de terminaison dédié :
GET /swagger
Le point de terminaison « Swagger » n’est pas imbriqué sous afin rest-path d’éviter les conflits de noms avec les entités configurées au runtime.