Discovering API Models from TIBCO Business Studio™

You can use the API Explorer view in the TIBCO Business Studio™ to view the APIs that reside on your local machine or on a remote server such as the TIBCO® Cloud Integration - API Modeler.

Prerequisites

For the API Explorer to discover the APIs residing on a remote server, the remote server must be up and running.

You can set up the locations to which you want the API Explorer to connect and look for the APIs. To do so, follow the steps below.

Procedure

  1. In TIBCO Business Studio™ , go to the API Explorer view.
  2. In the button bar within the API Explorer tab, click the View Menu downward-facing triangle icon () and select Settings.
    The Settings dialog will open.
    The registries for the TIBCO® Cloud Integration - API Modeler and the samples folder installed on your local machine are configured and appear in the API registry configurations box by default. In this dialog, you can specify how the discovered APIs will appear in the API Explorer:
    • API Presentation - specifies how the APIs will appear in the API Explorer

      Flat - displays the APIs as a flat list with each API's version number displayed next to its name in parenthesis. If there are multiple versions of the same API, each version will be shown as a separate API, hence multiple APIs with the same name but different version numbers.

      Hierarchical - displays every API as a hierarchy of API name lable with version number folder under it and the actual API under the version folder. If there are multiple versions for an API, each version will be listed in its own separate folder under the API name label.

      Latest Version - displays only the latest version of the API, even though there might be multiple versions available.

    • Group by API registry - groups the APIs according to the registry from which they were discovered
    • API registry configurations - displays the list of API registries that are currently configured in your TIBCO Business Studio™ installation. You can select the registries from where you want the API Explorer view to display the APIs by checking their check box(es).

    You can edit an existing registry by clicking the Edit button, delete the registry configuration by clicking Remove, or changing the order in which the registries show up in the API Explorer by using the Up and Down button. These button get activated when you click on an API registry name.

  3. Click New to add a new registry.
  4. In the Create new API Registry client configuration dialog do the following:
    1. Enter a name for the API registry that you will be mapping to in the Name text box.
    2. Select the Local radio button to map a location where the APIs are stored on your local machine's hard drive and navigate to the location using the Browse button. Alternatively, select the Remote radio button if you want to map to a remote server that contains the APIs and enter the URL for the server in the URL text box.
  5. Click Finish.
    You should now see the APIs displayed in the API Explorer in the format that you specified in the Settings dialog. Expanding an API will show you its version, the resource path, and the operations you can perform on that resource.
    The API Explorer view has the following quick-access buttons that you can use to format the way the APIs are listed:
    • Refresh
    • Expand All
    • Collapse All
    • Group by API Registry
    • API Presentation
    • API Registries. Selecting a registry from this drop-down list toggles between displaying and hiding the registry in the API Explorer.

    Use the search filter that appears at the bottom of the API Explorer view to search for API names that match the string that you enter in the Filter text box. You can search by typing in the version number, the full API name, or a full word within an API name. Wildcards is not supported. The search is case insensitive.