RESTAPI:Open API Documentation Endpoint: Unterschied zwischen den Versionen
Aus Cryptshare Documentation
(Die Seite wurde neu angelegt: „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 cryptshare.properties has to be created or modified to contain the following line: api.rest.openApiEndpoint=true After adding this entry in the file…“) |
Keine Bearbeitungszusammenfassung |
||
| Zeile 6: | Zeile 6: | ||
After adding this entry in the file, please restart the Cryptshare server. | 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 | The OpenAPI documentation is then available via the URL '''https://<your-url>/api/api-docs?group=cryptshare-ui-api-1''' | ||
Further details how the cryptshare.properties file has to be configured can be found in the chapter [[CSSCurrent en:Advanced Configuration|Cryptshare Server - Advanced Configuration]]. | Further details how the cryptshare.properties file has to be configured can be found in the chapter [[CSSCurrent en:Advanced Configuration|Cryptshare Server - Advanced Configuration]]. | ||
Version vom 12. Mai 2023, 16:55 Uhr
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 cryptshare.properties has to be created or modified to contain the following line:
api.rest.openApiEndpoint=true
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 cryptshare.properties file has to be configured can be found in the chapter Cryptshare Server - Advanced Configuration.