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.

Log on to the TIBCO® Cloud Integration website, click the API specs option; you are directed to the API Modeler page. The API Modeler page consists of the following two pages:

  • My API specs: lists all the API specifications imported and created by you. A sample Petstore API specification is added by default. 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.

    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. 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.

  • Trash: lists all the removed API specifications. On this page, you can restore a removed API specification or permanently delete an API specification. For more details, see Managing API Specifications in Trash.