BVS ID-M1280xF1-xx-xxx
4.2.3 Verfügbare Ressourcen und Anfragen
4.2.3.1 GET-Anfragen
API-Version abfragen
Ressource: versions
URL:
http://HOSTNAME/api/balluff/versions
Antwort:
Objekt
description
Beschreibung der API Version.
url
Die Versionsnummer, wie sie in der URL verwendet wird.
version
Die aktuelle API Version.
HINWEIS
Im Gegensatz zu den anderen Befehlen, ist die Versionsnummer nicht Teil der URL.
Beispiel:
[
[
{
"description":
"Current version of the REST
"url": "v1",
"version":
"1.0.0"
}
]
]
API-Beschreibung abfragen
Ressource: apidocs
URL:
http://HOSTNAME/api/balluff/v1/apidocs
Antwort: Eine YAML-Datei welche alle verfügbaren REST-Befehle beschreibt.
HINWEIS
Zur besseren Betrachtung der YAML-Datei kann Swagger-Editor wie z.B.
swagger-editor/
nutzen
Inhalt
API",
https://swagger.io/tools/
deutsch
69