REST API definitions are set up in a server module.
The API configuration is automatically published and updated when the server module is compiled.
The server module API definition consists of:
|
Definition |
Publish as Swagger V2 and/or OpenAPI 3 |
|
Info |
Title, Description, Terms of Service |
|
Security Requirements |
HttpBasic, API Key, OAuth2, OpenIDConnect |
|
Paths |
URLs that map to operations with parameters. Each operation is mapped to HTTP VERB and to server routine. |
|
Components |
Schema Types. Each schema type can be mapped to Field, Integer, String, Array, Object, Boolean or Number. Security Schemes |