Introduction to API Modeler
API Modeler is an easy yet powerful web-based tool that provides you with the capability to graphically create and model a REST API.
With API Modeler, you can import REST API specifications either in a YAML or JSON file for further editing, or model your own REST API step-by-step in a visual interface. After modeling an API, you can choose to mock it and see the API in action, or directly implement it.
To use API Modeler, log on to the TIBCO Cloud™ Integration website. On the global navigation bar, click , and click the API Model & Mock capability. You are directed to the API Modeler page.
Note: If the plan you purchased does not entitle you to use API Modeler, any related commands will be disabled.
The left of the page lists groups, which can be used to organize your API specs into different folders. Initially, there is only a Default group, but you can create more groups and move API specs between them. Click on the different groups to the left to display the API specs within that group.
The right side of the page lists all the API specifications imported and created by you, within the currently selected group. On this page, you can import API specifications or create your own REST APIs. For more details, see Importing API Specifications and Modeling an API.
Searching for API Specifications
You can also use the search box to find an API specification. Enter a search term to search all API names, versions, and descriptions. Matching APIs will be displayed within the current group. Searches are case-insensitive and support partial match, but not wild cards. You can also use double quotes around a string to find the exact match.
Sharing API Specifications Within Your Organization
Everyone in your organization can collaborate on the API specifications. That also means everyone has the ability to create, update and remove specifications.
Changes to the specifications are stored in API Modeler, but to make sure you don’t constantly see updates being pushed, you need to refresh your screen to see the updates made to the other specifications.
Note that like with most web-based editing programs, the last change that is made is persisted. If a user changes a GET operation and a second user edits that same GET operation, the last written update is persisted.