Open topic with navigation

TIBCO BusinessEvents® Enterprise Edition 6.3.1

# Enabling the RunTime Access to OpenAPI Specification

Accessing an OpenAPI specification for a TIBCO BusinessEvents application at run time requires the setting of some properties.

1. To access an OpenAPI specification over a server URL at run time, in the `be-engine.tra` file at `BE_HOME/bin` or in the project CDD file, set the following server property:

   Field | Description
   --- | ---
   `be.engine.api.spec.enable` | Set to true to enable the HTTP channel to generate and serve the OpenAPI specification at run time. By default, it is `false`.

2. This step is required if you start the TIBCO BusinessEvents engine from TIBCO BusinessEvents Studio for accessing a runtime specification.

   In TIBCO BusinessEvents Studio, set the `be.engine.api.spec.enable` server property in either of the following ways:

   - In the Run Configurations window, provide the start up property file, see Adding and Working with Launch (Debug or Run) Configurations.

   - In the project CDD file, add the server property in the Properties section on the Cluster tab.

3. To access an OpenAPI specification on a SwaggerUI, in the `be-engine.tra` file at `BE_HOME/bin` or in the project CDD file, set the following properties:

   Field | Description
   --- | ---
   `be.engine.openapi.version` | Specify the correct OpenAPI version. The OpenAPI version must match the value `3.0.n` to access the specification on a SwaggerUI page, for example `3.0.0`. The default value is `3.1.0`.
   `be.channel.http.propertiesAsXML` | Set to true to include event properties such as XML or JSON in the response when replying to an HTTP request event. The default value is `false`.
   `be.http.json.rootElement.ignore` | Set to true to exclude the root element and its attributes for the event with a JSON payload. The default value is `false`.

What to do next

See Accessing OpenAPI Specification at Run Time for accessing the OpenAPI specification of your TIBCO BusinessEvents application at run time.

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.