Skip to main content

 

Extensibility and Integration

 

 

OutSystems

Document an Exposed REST API

Adding documentation to your REST API is essential as it helps developers to integrate their applications 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.

Do the following:

  1. In Service Studio, make sure that your REST API methods and their parameters have their "Description" property filled in. You can use Markdown in the description to format the text.

  2. Publish the module.

The documentation is made available under the base URL of the REST API. To open it do the following:

  1. In Service Studio, right-click the tree element of your REST API.

  2. Choose Open Documentation.

  • Was this article helpful?