Invoke

Invoke

Swagger JSON specification of a process

Swagger JSON specification of a process

You can view the Swagger JSON specification of the payload of a process that you create in Informatica Process Designer.
The Swagger JSON specification of a process contains process payload features such as input, output, and process objects. The Swagger JSON specification contains the standard Swagger property requirements of
version
,
info
,
host
,
basePath
,
schemes
, and
paths
.

Accessing the Swagger JSON specification of a process

To access the Swagger JSON description of a process, perform one of the following tasks:
  • Open the process for which you want to view the Swagger JSON specification and click
    Actions
    >
    Properties Detail
    . Then, click
    View Swagger File
    next to the service URL.
    The following image shows the link to access the Swagger file:
    The image shows the generated Swagger file.
  • Open the process and click
    Actions
    >
    Properties Detail
    >
    Copy
    next to the service URL. Then, in a browser window, paste the service URL and append
    ?Swagger
    to the service URL.
    For example, if the service URL is
    https://bs1e1.rt.informaticacloud.com/active-bpel/rt/sample_process
    , paste
    https://bs1e1.rt.informaticacloud.com/active-bpel/rt/sample_process?Swagger
    in the browser window.
The Swagger JSON 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 Appendix- Response Status Codes.

Using the Swagger JSON specification of a process

You can use the Swagger JSON specification of a process with third-party tools. For example, you can use a Swagger JSON specification of a process with the Swagger.io codegen tool, http://swagger.io/swagger-codegen/.
You can use the Swagger JSON description with internal tools. For example, you can use the Swagger JSON specification of a process to create a file that you use to import a service connector. For more details, see
Design > Creating Service Connectors > Generating Service Connectors.

0 COMMENTS

We’d like to hear from you!