Skip to main content

Extensibility and Integration

 

OutSystems

Document an Exposed REST API

Adding documentation to your REST API is essential as it facilitates the life of any developer when integrating with your system.

OutSystems facilitates documenting your REST API by automatically generating the documentation when you publish the module. The documentation is based on the properties of the REST API, the REST API methods, and their parameters.

To reach this goal, do the following:

  1. Make sure your REST API, REST API methods, and their parameters have their Description property filled. You can use Markdown syntax in the Description to format the text;
  2. Publish the application.

The documentation is made available under the base URL of the REST API. To open it, right-click your REST API and choose Open Documentation.

  • Was this article helpful?