OpenAPI document
To properly document an API, a number of standards are available. Among those, the OpenAPI standard is the most well-known. That is why this standard has been chosen to document the REST API.
The OpenAPI document can be used in tools such as
Postman or
Swagger, and is intended for developers to get a better understanding of the workings of the Planon Generic REST API.
Our OpenAPI document consists of the following sections:
• "openapi" section shows the openapi version
• "info" section provides metadata about the API
• "servers" section shows the server where the API is running
• "security" section contains the required security scheme to execute the operations
• "paths" section shows the relative paths to the endpoints and their operations
• "components" section holds a set of reusable objects for various aspects of the OpenAPI Specification