LinkedIn
Copied!

Table of Contents

Viewing application-specific REST APIs

Version:

Only available versions of this content are shown in the dropdown

View the OpenAPI Specification (OAS) documentation that describes your application's REST APIs in either App Studio or Dev Studio. You can also view the OAS documentation for individual REST services and for the REST services that are included in a service package.

  1. To view application-specific REST APIs in App Studio:

    1. In the navigation pane of App Studio, click Channels.

    2. On the Channels page, click API.

  2. To view application-specific REST APIs inDev Studio:

    1. In the header of Dev Studio, click the name of the application, and then click Channels and interfaces.

    2. On the Create new channel interface page, click API.

  3. To view the OAS documentation for an individual REST service:

    1. In the navigation pane of Dev Studio, click Records.

    2. Expand the Integration-Services category, and then click Service REST.

    3. Click a Service REST rule to open it.

    4. Click the OpenAPI tab to view the REST service in YAML and Swagger.

  4. To view the OAS documentation for the REST services included in a specific service package:

    1. In the navigation pane of Dev Studio, click Records.

    2. Expand the Integration-Resources category, and then click Service Package.

    3. Select a service package, for example, myDemoPackage, to open it.

    4. Click the OpenAPI tab to view all of the REST services included in the service package in YAML and Swagger.

Did you find this content helpful?

Have a question? Get answers now.

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