RESTAPI/Get openAPI Documentation: Unterschied zwischen den Versionen

Aktuelle Version vom 16. März 2023, 17:11 Uhr

To obtain the OpenAPI 3.0 Documentation for the Cryptshare Server, make sure there is a file 'cryptshare.properties' in the Crptshare Server directory.

Make sure it is UTF-8 encoded. (Not UTF-8 with BOM)

It must contain the value

api.rest.openApiEndpoint=true

After restarting the Cryptshare Server, you can reach the documentation under

http://localhost/api/api-docs?group=cryptshare-ui-api-1

@@ Zeile 1: / Zeile 1: @@
-Um die Dokumentation dazu mit dem Cryptshare Server zu erzeugen, falls nicht vorhanden, im Installationsverzeichnis des Cryptshare Servers eine Datei "cryptshare.properties" anlegen.
+To obtain the OpenAPI 3.0 Documentation for the Cryptshare Server, make sure there is a file 'cryptshare.properties' in the Crptshare Server directory.
-Darauf achten, dass die Datei UTF-8 kodiert ist (nicht UTF-8 mit BOM)
-Dort den Wert
+Make sure it is UTF-8 encoded. (Not UTF-8 with BOM)
-api.rest.openApiEndpoint=true
+It must contain the value
-Hinzufügen.
+ api.rest.openApiEndpoint=true
+After restarting the Cryptshare Server, you can reach the documentation under
-Nach einem Neustart des Cryptshare Servers ist unter
+ http://localhost/api/api-docs?group=cryptshare-ui-api-1
-http://localhost/api/api-docs?group=cryptshare-ui-api-1
-die OpenAPI Dokumentationen erreichbar.