Open topic with navigation

TIBCO BusinessEvents® Enterprise Edition 6.3.1

# 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.

   Field | Description
   --- | ---
   `http://host_name:port_number/openapi.json` | Enter to access the OpenAPI specification in a JSON format.
   `http://host_name:port_number/openapi.yaml` | Enter to access the OpenAPI specification in a YAML format.
   `http://host_name:port_number/swagger/index.html` | Enter 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.

Did you find this helpful?

YesNo
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO BusinessEvents® Enterprise Edition

Copyright © 2004-2024. Cloud Software Group, Inc. All Rights Reserved.