RESTAPI/Get openAPI Documentation

Aus Cryptshare Documentation
Version vom 16. März 2023, 17:11 Uhr von Bodenweberd (Diskussion | Beiträge)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Wechseln zu:Navigation, Suche

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