Open topic with navigation

TIBCO BusinessEvents® Enterprise Edition 6.3.1

# Accessing AsyncAPI Specification at Run Time

You can access the AsyncAPI specification for a running TIBCO BusinessEvents application over a URL and it can be maintained in a repository on a server.

A runtime specification can synchronize a TIBCO BusinessEvents application with its AsyncAPI specification.

Before you begin

Enable the access to the AsyncAPI specification over the server URL by configuring properties, see Enabling the Runtime Access to AsyncAPI Specification.

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

       http://host_name:port_number/asyncapi

   The parameter `asyncapi` lists all available channels in the project.

3. To generate the AsyncAPI specification for a particular channel, provide the channel name to the endpoint:

    http://host_name:port_number/asyncapi?chName=/Channels/channel_name

For example,

    http://host_name:port_number/asyncapi?chName=/Channels/KafkaChannel

4. To generate the AsyncAPI specification in a YAML format, append the parameter `generateYaml=true` to the endpoint:

       http://host_name:port_number/asyncapi?chName=/Channels/channel_name&generateYaml=true

Result

The AsyncAPI specification is generated and served on the specified HTTP port at run time.

The specification is regenerated every time the endpoint has been entered.

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.