Generating a Swagger JSON File from TIBCO Business Studio - BPM Edition

Swagger is a set of open-source tools that can help you design, build, document, and consume REST APIs. Swagger scans the application code and exposes the documentation on the URL. You can consume this URL (a JSON document) to understand the capabilities of the REST service without accessing the actual source code and documentation. You can now generate aSwagger.json file from TIBCO Business Studio - BPM Edition as mentioned in the following steps.

    Procedure
  1. Click a promoted service.
  2. In the Properties view, click the Bindings tab.
  3. Select REST binding.
  4. In the right pane of the Properties view, click the Generate Swagger link at the bottom. The Swagger Generation dialog displays.

  5. Enter or select the parent folder field. Accept the default folder or select a new one.
  6. In the File name field, accept the default name (swagger_gen.json) or type a new one.
  7. Click Next. The Concrete JSON Settings screen displays.
  8. Accept the default values of host, port, and scheme. Optionally, you can enter new values. Click Finish.

    A Swagger JSON file is generated in the parent folder and the file is opened in the editor.