1. OpenAPI-Spezifikation

Die OpenAPI-Spezifikation ist ein Standard zur Beschreibung von REST-APIs.

Die REST-API des FVA Simulation Hub ist vollständig nach OpenAPI v3.0.3 (siehe spec.openapis.org/oas/v3.0.3) spezifiziert. Die Spezifikationsdatei befindet sich im Installationsverzeichnis unter docs/schema/openapi.yaml.

Mit dem OpenAPI-Generator (siehe openapi-generator.tech/) besteht die Möglichkeit, Quellcode aus der OpenAPI-Spezifikation zu generieren. Dabei werden bereits viele verschiedene Programmiersprachen unterstützt.

2. Java-Bibliothek

Kommt für die Entwicklung von Client-Anwendungen die Programmiersprache Java zum Einsatz, dann kann als Basis die bereitgestellte Java-Bibliothek verwendet werden.

Die Java-Bibliothek befindet sich im Installationsverzeichnis unter docs/libs/java. Es sind alle Modell-Klassen enthalten, die auch im FVA Simulation Hub für den Austausch der Objekte zwischen Client und Server verwendet werden.