Open topic with navigation

TIBCO BusinessEvents® Enterprise Edition 6.3.1

# Exporting AsyncAPI Specification by Using the Command-Line Utility

You can export a project as a AsyncAPI specification by using the `studio-tools` command-line utility.

Procedure
1. Navigate to ``BE_HOME```/studio/bin/`.
2. Open the `studio-tools` utility.
3. On the command prompt, run the following command:

       studio-tools.exe -core exportAsyncAPI [-h] [-x] [-o specificationFileName] [-d outputDirectory] [-genyaml generateYAMLSpecification] [-jsonpayload isJsonPayload] [-p projectDir] [-ch channelName]

   For example:

       studio-tools.exe -core exportAsyncAPI -o httpAsyncAPI -p ..\..\examples\standard\HTTPChannel\HTTPChannel -ch HTTP

## Options

The following table describes the command parameters:

exportAsyncAPI SpecificationOptions
Option | Description
--- | ---
`-core exportAsyncAPI` | Specifies the `exportAsyncAPI` operation for exporting a TIBCO BusinessEvents Studio AsyncAPI specification into the workspace. The exported specification file is by default in JSON format.
`-h` | Optional. Displays help.
`-x` | Optional. Overwrites the specified output file if it exists when the value of `-x` is set to True. If the value of `-x` is set to False, then the export operation does not proceed and a different output file should be mentioned. If the value of `-x` is not specified, then a confirmation message prompts whether to overwrite the output file.
`-o` | Optional. Specifies the exported AsyncAPI specification file name. The Project name is the default specification name.
`-d` | Optional. Specifies the absolute path to the output directory where the AsyncAPI specification is exported. The default path where the specification file exports is the source project path.
`-p` | Source project: Specifies the absolute path to the project directory of the TIBCO BusinessEvents Studio project.
`-genyaml` | Optional. Generates a YAML file format for the exported AsyncAPI specification.
`-jsonpayload` | Optional. Specifies the JSON payload for the exported AsyncAPI specification.
`-ch` | Specifies the channel name from the project. You can select only one channel at a 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.