Die OpenAPI Specification, früher bekannt als Swagger Specification, ist eine Spezifikation für maschinenlesbare Schnittstellendateien zur Beschreibung, Erzeugung, Nutzung und Visualisierung von RESTful-Webservices. Sie war früher Teil des Swagger-Frameworks und wurde 2016 ein eigenständiges Projekt, das von der OpenAPI Initiative betreut wird – einem Open-Source-Kollaborationsprojekt der Linux Foundation. Swagger und einige andere Tools können aus einer Schnittstellendatei Code, Dokumentation und Testfälle generieren.
Anwendungen, die auf Basis von OpenAPI-Schnittstellendateien implementiert sind, können automatisch Dokumentation zu Methoden, Parametern und Modellen erzeugen. Das hilft dabei, Dokumentation, Client-Bibliotheken und Quellcode synchron zu halten.
Ein neuer OpenAPI-WebService wurde veröffentlicht (derzeit BETA), der die OpenAPI 3.0 Specification im JSON-Format einliest und automatisch einen Delphi-Client in nativem Pascal-Code erzeugt. Der WebService erstellt zudem eine Demo, die zeigt, wie du mit der API interagierst.
Der WebService benötigt eine Spezifikation in 3.0+ und im JSON-Format.
OpenAPI-Spezifikation importieren
Der erste Schritt ist der Import der OpenAPI-3.0-Spezifikation. Dafür verwenden wir eine einfache OpenAPI-Spezifikation von abstractapi.com, mit der sich der Standort einer IP-Adresse abrufen lässt. Unten findest du die Spezifikationsdatei:
Sobald du die OpenAPI-3.0-Spezifikation im JSON-Format hast, kannst du mit unserem OpenAPI-WebService die benötigten Delphi-Dateien generieren – rufe dazu folgende URL auf:
https://www.esegece.com/products/openapi/ws/demo
Setze einfach den Klassennamen (standardmäßig TsgcOpenAPI_Test) und lade die Spezifikationsdatei hoch (zuerst entpacken!!! Muss im JSON-Format sein). Klicke abschließend auf den Button Upload, um die Datei zu verarbeiten.
War der Vorgang erfolgreich, wird eine neue komprimierte Datei mit einer kompilierten Demo heruntergeladen.
OpenAPI-Demo testen
Bevor du die Demo testen kannst, musst du dir bei abstractapi.com ein kostenloses Konto erstellen, um einen API-Key zu erhalten.
https://app.abstractapi.com/users/signup
Entpacke die heruntergeladene Datei und wechsle in den Ordner Demo. Dort findest du die Datei sgcOpenAPIDemo.exe – starte sie.
Es öffnet sich ein neues Formular mit der URL von abstractapi.com.
Klicke auf den Weiter-Button, wähle die Methode Retrieve_the_location_of_an_IP_address und fülle den Api_Key sowie die zu prüfende IP-Adresse aus. Wird die Anfrage erfolgreich verarbeitet, erhältst du eine JSON-Nachricht mit Informationen zur IP-Adresse zurück.
Unten findest du die vom sgcOpenAPI-WebService automatisch generierte komprimierte Datei für die Tests.