Swagger UI

The Swagger UI is an open source project to visually render documentation for a Swagger-defined API, directly from the API's Swagger specification. Currently, it uses the Swagger specification 3.0 version.

The REST APIs are grouped and tagged as per their category. For example, all the APIs related to batch function are tagged under the Batch Apis heading.

See the following sample of a Swagger UI window for one of the TIBCO PSI services.

The following information is displayed on the Swagger UI.

Base URL: Each server has a base URL that has the following format. All API endpoints are relative to the base URL.

scheme://host[:port][/path][parameters]

Example:

http://localhost:8080/restapi/v1/party

Where

  • localhost is the host

  • 8080 is the port to access the host

  • http://localhost:8080 is the base URL

  • /restapi/v1/party is the endpoint path

  • Port Type: Port type of service.

  • Schemes: Security schemes used to run the operations.

  • Operations: Shows a list of all the operations that are implemented by the REST Service on each Endpoint. Operations are HTTP methods (for example GET, POST, DELETE) used to access the Base URL.
    From this field, you can invoke an operation and receive a live Response for the specific inputs.

  • Models: Shows the schema in detail in JSON format. It shows how data in the WSDL and XSD is configured.