Accessing the API Documentation with Swagger UI

To access the API documentation, perform the following steps:

Procedure

In TIBCO Control Plane, click Data Planes from the left navigation.
On the Data Plane card of your choice, click Go to Data Plane.
In the Capabilities section, select the FLOGO capability.
On the TIBCO Flogo® Enterprise Capabilities page, click API Docs from the upper-right corner.

ResultThe TIBCO Flogo® Capability APIs are displayed on the Swagger UI.

The Swagger UI page contains the following sections:

Apps and Builds - This section contains all the APIs available to manage app builds.
Apps - Managed by FLOGO Provisioner - This section contains all the APIs available to manage apps using the Flogo Provisioner.
Apps - Managed by Helm Chart - This section contains all the APIs available to manage apps using the Helm Chart.
Provisioned Software & Connectors - This section contains all the APIs available to manage provisioned software and connectors in the data plane.

What to do nextYou can try out the APIs on the Swagger UI by selecting the Try it out option for each API.

Did you find this helpful?

Yes No