Learn how to generate accurate and complete OpenAPI Specification (OAS) documentation for your REST APIs, and learn where to view your REST APIs in your application.
- Best practices for generating OpenAPI Specification documentation
OpenAPI Specification (OAS) documentation is automatically generated for every REST service rule. The OAS documentation for each REST service included in a service package is then combined into a single OAS document.
- Generating OpenAPI Specification documentation for application-specific REST APIs
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.
- Viewing application-specific REST APIs
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.
- OpenAPI tab
Use the OpenAPI tab to view the auto-generated OpenAPI Specification (OAS) documentation that describes the REST services that are included in your service package. The OpenAPI tab displays the REST services in YAML and Swagger.
- Invoking a REST service rule
Call a REST service rule from an external system to invoke an action in your application or retrieve data from Pega Platform. For example, you can call a REST service to get the details of a case or assignment. You can specify the application context in which to run the API by using the application alias URL.
- Using OAuth2 authentication with the Pega-provided Swagger UI
Authenticate with the Pega-provided Swagger UI so that you can test your Pega APIs, by creating an OAuth 2.0 client registration. Use the client ID and secret from your OAuth 2.0 client registration to define the scope of end-user access to the Swagger UI.