Accessing OpenAPI Specification at Run Time

You can access the OpenAPI specification for a running TIBCO BusinessEvents application over a URL or SwaggerUI page.

Before You Begin

Enable the runtime OpenAPI specification access, see Enabling the RunTime Access to OpenAPI Specification.

    Procedure
  1. Run the TIBCO BusinessEvents engine for a project which you want to generate an OpenAPI specification for.
  2. When TIBCO BusinessEvents engine is running, in the browser, enter the following HTTP channel URL endpoint:

    The port number must be the port number used in the HTTP shared resource.

    FieldDescription
    http://host_name:port_number/openapi.json

    Enter to access the OpenAPI specification in a JSON format.

    http://host_name:port_number/openapi.yamlEnter to access the OpenAPI specification in a YAML format.
    http://host_name:port_number/swagger/index.htmlEnter to access the OpenAPI specification on a SwaggerUI.

    To access the OpenAPI specification for a particular channel from a project containing multiple channels, specify the correct port number of the channel in the URL.