I would like to generate documentation for the APIs I've created on my System.
How can I do this?
What is the advised way to document my API?
Hi Mieke,
There is no automated way to generate API docs from User-Defined APIs configured in DataMiner. There is a reply to another Dojo question that elaborates a bit more about that: https://community.dataminer.services/question/user-defined-api-overview-and-documentation-of-deployed-apis/answer/104948/
As mentioned in that reply, there are editor tools out there that you can use to write API docs according to the Open API specification. This will allow you to load these files into other tools that visualizes and tests them. I found a Visual Studio Code extension called 'OpenAPI (Swagger) Editor' which seems promising for this purpose.