Über generische OpenAPI Dokumente können verschiedene REST Client automatisiert erstellt werden, z. B. JavaScript, Java oder C#. Das OpenAPI Dokument ist ein JSON Dokument und beschreibt das die API Formalformal.
OpenAPI Dokument
Um auf das OpenAPI Dokument der AMPAREX API zuzugreifen, dient folgender Link:
https://<host>/amparex/webaxapi/v2/api-docs
oder
http://<host>:8080/amparex/webaxapi/v2/api-docs
Je nach Server muss <host> durch den Server (z. B. preview1) ersetzt werden. Das Ergebnis ist ein JSON Dokument, das aus dem Browser kopiert werden muss:
...
Hinweis |
---|
Bitte beachten Sie, dass der Zugriff auf das Open-API OpenAPI Dokument nur auf Testservern funktioniert. |
Dieses JSON Dokument ist die Beschreibung der AMPAREX API und kann z. B. für SwaggerHub verwendet werden.
SwaggerHub
Nun benötigt man noch das Swagger Tool 'Swagger-UI', um die API zu visualisieren. Dazu sind folgende Schritte nötig:
Beschreibung | |
---|---|
(01) Account unter SwaggerHub anlegen. (02) Bei SwaggerHub einloggen. (03) Neue API erstellen |
...
. |
...
(04) Dialog wie |
...
nebenstehend ausfüllen |
...
...
(05) Create API klicken. (06) Nun öffnet sich die Swagger-UI mit dem OpenAPI Editor. Im linken Teil befindet sich der Editor und im rechten Teil die Dokumentation der API. | |
(07) Nun das zuvor kopierte OpenAPI JSON Dokument von der URL 'http://localhost:8080/amparex/webaxapi/v2/api-docs' in das linke Editor-Fenster kopieren |
...
. (08) Die Frage, ob von JSON in XAML konvertiert werden soll, mit 'JA' bestätigen. | |
(09) Nun wird rechts in der Vorschau die API Dokumentation angezeigt |
...
. (10) Dieses Dokument ist die Dokumentation der API. Im oberen Teil befinden sich die einzelnen Zugriffsmethoden der API. Im unteren Teil ist das |
...
Modell, d. h. die Entitäten (z. B. Artikel) beschrieben. | |
(11) Im Kopfmenü von SwaggerHub gibt es eine Download-Schaltfläche. Über diese kann einfach ein RestClient Projekt erstellt werden, mit dem komfortabel die API verwendet werden kann |
...
. (12) Dort sind die verschiedensten Sprachen zu finden. In unserem Beispiel wird ein Java Client erstellt. | |
(13) Das erstellte Zip File wird gespeichert |
...
. (14) Das Projekt kann in einer Java Entwicklungsumgebung geöffnet werden. Am |
...
besten erstellt man sich daraus ein JAR File. | |
(15) Eine 'Test Main Klasse' zeigt die Verwendung des Rest-Java-Clients |
...
|