La spécification OpenAPI, anciennement connue sous le nom de spécification Swagger, est une spécification pour les fichiers d'interface lisibles par machine destinés à décrire, produire, consommer et visualiser des services web RESTful. Anciennement partie du framework Swagger, elle est devenue un projet indépendant en 2016, supervisé par l'OpenAPI Initiative, un projet de collaboration open source de la Linux Foundation. Swagger et d'autres outils peuvent générer du code, de la documentation et des cas de test à partir d'un fichier d'interface.
Les applications implémentées à partir de fichiers d'interface OpenAPI peuvent générer automatiquement la documentation des méthodes, des paramètres et des modèles. Cela permet de maintenir la documentation, les bibliothèques client et le code source synchronisés.
sgcOpenAPI Generator permet de générer automatiquement des bibliothèques client API (génération de SDK) à partir d'une spécification OpenAPI. Les spécifications OpenAPI suivantes sont prises en charge :
sgcOpenAPI vous permet de générer automatiquement l'interface API client en langage Pascal natif à partir d'un OpenAPI ou Swagger JSON/YAML. Prend actuellement en charge de Delphi 7 à la dernière version Delphi.
sgcOpenAPI Generator vous permet de créer un fichier de documentation à partir d'une spécification OpenAPI / Swagger.
En savoir plus sur l'analyseur OpenAPI Pascal.
L'interface Client générée contient toutes les fonctions/méthodes définies dans la spécification OpenAPI. Les constantes et les énumérations sont également créées.
Les méthodes d'authentification suivantes sont prises en charge :
En savoir plus sur le Client OpenAPI.
Vous pouvez également héberger un service OpenAPI 3.0 en Delphi en utilisant le serveur OpenAPI intégré. Le serveur route automatiquement les requêtes par rapport à votre spécification, sert la spécification à /openapi.json et une Swagger UI à /docs, et prend en charge CORS et la validation des requêtes/corps prêt à l'emploi.
Deux façons de définir l'API :
En savoir plus sur le Serveur OpenAPI.
Les API suivantes ont été compilées et sont prises en charge :