The OpenAPI specification, previously called Swagger specification, is a format for describing REST API endpoints.
Application Integration supports OpenAPI specification version 3.0.1. You can view the OpenAPI specification of the payload of a process that you create in Process Designer.
The OpenAPI JSON specification of a process contains process payload information such as input, output, descriptions, and process objects. The OpenAPI specification specifies the standard OpenAPI property requirements of version, info, servers, paths, and components.
The OpenAPI 3.0.1 specification is more descriptive than Swagger 2.0 and allows you to create complex documents.
Accessing the OpenAPI JSON specification of a process
To access the OpenAPI 3.0 specification of a process, perform the following steps:
1On the Explore page, navigate to the process for which you want to view the OpenAPI specification.
2On the Actions menu, click Properties Detail to view the generated OpenAPI file.
The Properties Detail dialog box appears.
The following image shows the link to access the OpenAPI 3.0 file:
3Click View OpenAPI 3.0 File to view the associated OpenAPI file.
The OpenAPI 3.0.1 specification opens on a new tab.
The OpenAPI 3.0.1 specification for the processes shows the HTTP response status code, step name, and the HTTP response header name and type that you configured in the End step or the Milestone step. However, if a process contains a Receive step, the HTTP response status code remains 200 OK irrespective of the configuration. For more information about the response status codes that Application Integration supports, see HTTP response status codes.
