RESTAPI:Open API Documentation Endpoint

Aus Cryptshare Documentation
(Weitergeleitet von RESTAPI:Open API Documentation)
Wechseln zu:Navigation, Suche

Cryptshare servers offer the possibility to generate an OpenAPI documentation. This may come in handy if the Cryptshare server is not up-to-date and this documentation only applies to the most recent Cryptshare server version.

Activate the OpenAPI endpoint

For activating the OpenAPI endpoint, the file has to be created or modified to contain the following line:

After adding this entry in the file, please restart the Cryptshare server.

The OpenAPI documentation is then available via the URL https://<your-url>/api/api-docs?group=cryptshare-ui-api-1

Further details how the file has to be configured can be found in the chapter Cryptshare Server - Advanced Configuration.