Open topic with navigation

TIBCO BusinessEvents® Enterprise Edition 6.3.1

# Importing OpenAPI Specification

TIBCO BusinessEvents Studio can consume an OpenAPI specification and automatically generate artifacts in a TIBCO BusinessEvents project by using the import utility.

Procedure
1. In Studio Explorer, right-click anywhere in the project and select Import.

   The Import window opens.

2. Select TIBCO BusinessEvents > OpenAPI Specification and click Next.
3. In the OpenAPI Specification Import window, provide the following details.

   Field | Description
   --- | ---
   Import From URL | Select this checkbox to import an OpenAPI specification directly from an URL. You can also import an OpenAPI specification from a third-party cloud product such as Github.
   Select File | Browse and select an OpenAPI specification file in JSON or YAML format from your local file system. You can drag a local OpenAPI specification file from your system and drop it to this field and it picks the file path.
   Provide URL | Provide an URL to import an OpenAPI specification from. This field is enabled if you select the Import from URL checkbox.
   User name | Username for accessing the remote repository URL.
   Password | Password for accessing the remote repository URL.
   Enter or select the parent folder | Select a TIBCO BusinessEvents project where you want to create artifacts.

4. Click Finish.

   If the imported OpenAPI specification has any error or invalid value, you see an error message and no artifacts are imported. The error details are printed on TIBCO BusinessEvents Studio console.

5. Save the project.

Result

The supported project artifacts for the HTTP channel are created under the respective artifacts folders in TIBCO BusinessEvents Studio as per the configuration mentioned in the OpenAPI specification. The hierarchy and relationships between the artifacts are maintained.

Subtopics

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.