Skip to main content




Service Studio version:

Document an Exposed REST API

  • Edit
    Collaborate with us
    Edit this page on GitHub
  • 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 platform generates the documentation from 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.

    OutSystems publishes the documentation 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?