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
- In Studio Explorer, right-click anywhere in the project and select
Import.
The Import window opens.
- Select TIBCO BusinessEvents > OpenAPI Specification and click Next.
- In the OpenAPI Specification Import window, provide the following details.
Field Description Import From URL Select this check box 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.
The URLs that require any authentication to access them are not supported.
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 will pick 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 check box.
Enter or select the parent folder Select a TIBCO BusinessEvents project where you want to create artifacts. - 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.
- Save the project.
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.