Open API usage

Open API is a specification that allows you to describe RESTful APIs in a standardized way. It makes APIs easier to understand and use, and also enables automatic generation of documentation and client code. Sensedia Docs supports creating API documentation using Open API, allowing you to describe your endpoints, parameters, responses, and other details clearly and in a structured manner.

Creating Open API documentation

To create Open API documentation in Sensedia Docs, you can follow these steps:

Viewing the documentation

After adding the component, you can view the Open API documentation directly in Sensedia Docs. The documentation will be rendered automatically, showing details of endpoints, parameters, responses, and other aspects of the API.

Local usage example