Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Automatically generate OpenAPI Specification documentation for application REST APIs (8.3)

Updated on May 3, 2021

In App Studio, you can view the OpenAPI Specification (OAS) 3.0 documentation generated for your application REST APIs by using the new Application tab in the API channel. The Application tab provides a single location for viewing all the application-specific REST APIs that your application documents so that you can easily find, understand, and test them. The following figure shows an example of the list of REST APIs that are displayed on the Application tab.

"rest apis"
Application tab with list of REST APIs

In Dev Studio, the Integration & security tab of your application rule now includes a Service Packages section. You can curate the list of services that are documented in your application by listing the service packages that contain them in your application rule. For example, if you list a service package called myDemoPackage in your application rule, the REST APIs for the services included in myDemoPackage are displayed on the Application tab in App Studio. The following figure shows the Service Packages section of the application rule.

"service packages"
Service Packages section of the application rule

Additionally, in Dev Studio, you can use the OpenAPI tab in the service package rule to view the automatically generated OAS documentation for all the REST services in the service package in YAML and Swagger UI. The following figure provides an example of the OpenAPI tab for a healthcare application API.

OpenAPI tab in the service package rule

For more information, see Generating OpenAPI Specification documentation for application-specific REST APIs.

  • Previous topic Migrate case attachments from Pega database storage to a repository (8.3)
  • Next topic Troubleshoot data and integrations in UI elements by using the Live Data tool (8.3)

Have a question? Get answers now.

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

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us