Question #1436
closed
API - documenation
Description
Not sure what the current plans for our API documentation are but I stumbled upon this API documentation: https://cesium.com/docs/rest-api/ from cesium and liked it at the first glance. It:
- looks friendly, not overwhelming
- includes links to tutorials at the beginning
- has a clear presentation and description of parameters, responses and the like
I would like something like this for OpenAtlas too. Are there already plans how to proceed there for our API, which tools to use (Sphinx?) and so on?
Updated by Bernhard Koschiček-Krombholz over 3 years ago
We will have the swagger documentation, which will be available under /apidocs/. Swagger provides a very good overview about all possible paths, parameter, errors and structure of the results. It will NOT provide a tutorial or step-by-step guide! Since I thought, this was not desired, I discarded such ideas.
The documentation of cesium looks very nice. If we want a tutorial, I write a sphinx documentation. Right now, I'm enjoying my holidays, but when the new API version is done, you can see the swagger API documentation, and we can discuss further additions and documenting methods.
Updated by Alexander Watzinger over 3 years ago
- Status changed from Acknowledged to Closed
- Target version deleted (
208)
Thank you for the quick feedback about the planned API documentation and keep enjoying your holiday ;)