Search Results

Previewing and Exporting API

After defining and modeling your REST API, you can perform the following operations:

  • Click Export in the upper right corner to export the API definition to a JSON file or a YAML file on the local filesystem or Github. See Exporting to Github below for more information.
  • Click Preview to view the API on the API Preview page.

Exporting to Github

API specifications can be exported to Github:

  1. Click Export to export the API definition to a JSON file or a YAML file on the local filesystem or Github.

  2. Select Github and click Next.

  3. Follow the steps in Importing from Github to sign in and authorize TIBCO Cloud Integration

  4. All the GitHub repositories that you can access will be displayed in the Export to GitHub window.

    The left side panel of the window is the list of all the repositories in which you have read or write permissions, which includes organization repositories. For example, the CatChasing repository of the PetChasers organization is displayed there, which only happens when the access request you sent earlier has been approved by the owner of the PetChasers organization.

    TIBCO® Cloud Integration only supports export to the master branch of the repositories on GitHub.

  5. Select a GitHub repository, and enter a File Name and Commit message.

    You can choose the repository from the left panel, navigate to the target folder and export to API specifications from this folder.

  6. Click Export.

Note: If you choose an organization repository to export your API specifications, make sure you have the write permission to this repository. By default, your permissions follow the organization Member privilege. If the organization member has Read permission, you will need to have the organization Admin add you into a team that has Write permission to the desired repository of this organization in order to export to this repository. Please refer to your GitHub organization owner for the details.

What to Do Next

  • Try and test the API against a live endpoint. For more details, see Creating a Mock App.
  • Fetch and implement the API using TIBCO Business Studio™ - Cloud Edition.