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 permettant de décrire, produire, consommer et visualiser des services web RESTful. Auparavant partie du framework Swagger, elle est devenue un projet distinct 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, paramètres et modèles. Cela aide à maintenir la documentation, les bibliothèques clientes et le code source synchronisés.
Un nouveau WebService OpenAPI a été publié (actuellement en BETA) qui lit la spécification OpenAPI 3.0 au format JSON et crée automatiquement un client Delphi en code Pascal natif. Le WebService crée une démo qui montre comment interagir avec l'API.
Le WebService nécessite que la spécification soit en 3.0+ et au format JSON.
Importer une spécification OpenAPI
La première étape consiste à importer la spécification OpenAPI 3.0 ; pour cela, j'utiliserai une spécification OpenAPI simple utilisée par abstractapi.com pour récupérer l'emplacement d'une adresse IP. Tu trouveras ci-dessous le fichier de spécification :
Une fois la spécification OpenAPI 3.0 au format JSON en ta possession, tu peux générer les fichiers Delphi requis avec notre WebService OpenAPI. Va à l'URL suivante :
https://www.esegece.com/products/openapi/ws/demo
Définis simplement le nom de classe (par défaut TsgcOpenAPI_Test) et téléverse le fichier de spécification (décompresse-le d'abord ! il doit être au format JSON). Appuie enfin sur le bouton Upload pour traiter le fichier.
Si le processus réussit, un nouveau fichier compressé sera téléchargé avec une démo compilée.
Tester la démo OpenAPI
Avant de tester la démo, tu dois créer un compte gratuit sur abstractapi.com pour obtenir une clé API.
https://app.abstractapi.com/users/signup
Décompresse le fichier téléchargé et va dans le dossier Demo ; tu y trouveras un fichier sgcOpenAPIDemo.exe, exécute-le.
Un nouveau formulaire s'affiche, montrant l'URL d'Abstractapi.com.
Appuie sur le bouton suivant et sélectionne la méthode Retrieve_the_location_of_an_IP_address, puis renseigne Api_Key et l'adresse IP à rechercher. Si la requête est traitée avec succès, un message JSON est renvoyé avec les informations sur l'adresse IP.
Tu trouveras ci-dessous le fichier compressé généré automatiquement par le WebService sgcOpenAPI pour effectuer les tests.