Using Swagger to Create a REST Reference

If you have the Swagger file, you can import it into TIBCO Business Studio for BusinessWorks and create a REST reference from it. At the time of the reference creation the service created using that Swagger file may or may not be running or even exist. But when the reference actually invokes the service, at the time of the invocation of the service by the reference, the service must be running and accessible to the reference process. References that are created using an imported Swagger file, cannot be modified in TIBCO Business Studio for BusinessWorks. You can only view the details of such a reference.

Before you begin The Swagger file must be imported into the Service Descriptors folder of the project. For Swagger files on your local machine you can import them by pointing the File Explorer to the location of the Swagger file, then dragging and dropping the file from the File Explorer into the Service Descriptors folder of your project. For Swagger files that reside on the cloud, you can use the API Explorer view to get the Swagger specifications that were created in API Modeler. Drag and drop the Swagger file into the Service Descriptors folder.

For more information, see the API Explorer topic.

To create a REST reference from a Swagger file:

Expand the .json file in the Service Descriptors folder in Project Explorer.
Drag and drop an endpoint in the API from the Service Descriptors folder to the right boundary of the Process Editor.

Note:

For Swagger 3.0 files with callbacks, to create a REST reference for the callback, drag a callback URL from the tree view in the Project Explorer pane to the process editor.