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 located 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 located 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 as XML or JSON in the response when replying to an HTTP request event. The default values is false.
   be.http.json.rootElement.ignore	Set to true to exclude the root element and its attributes for event with JSON payload. The default values is false.