LinkedIn
Copied!

Table of Contents

Generating OpenAPI Specification documentation for application-specific REST APIs

Version:

Only available versions of this content are shown in the dropdown

You can list service packages that contain REST services in your application rule to include their OpenAPI Specification (OAS) documentation in your application's OAS documentation. All of the services that you list are documented together in a single application OAS landing page, which you can view in the application's API channel.

To ensure that you generate accurate and useful OAS documentation, review the Best practices for generating OpenAPI Specification documentation.
  1. In the header of Dev Studio, click the name of the application, and then click Definition.

  2. On the Application form, click the Integration & security tab.

  3. In the Service Packages section, select the service packages that you want to document:

    • To add a package, click the Add item icon, and then select a service package from the list.
    • To remove a service package, in the row for that service package, click the Delete icon.
  4. Click Save.

Confirm that the OAS documentation for the REST services included in your service package was generated. For more information, see Viewing application-specific REST APIs.

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.