Managing API specs with API Modeler

Last updated:
10:37pm Aug 26, 2019

Modeling and testing APIs

  1. Getting started
  2. Prerequisites
  3. My first API
  4. Adding resources
  5. Import & Export
  6. Managing API specs
  7. Testing with Mock apps
  8. Advanced topics

As the number of API specs you have in the list grows, you need to manage them as well.

Searching

You can use the search box to find an API spec. Simply enter some text in the search box to search for API names, versions, and descriptions. The API specs that match will be displayed. Searching is limited to the group you have selected, so if you want to search all API specs, make sure you select that group. The searches are case-insensitive and support partial matching. As with search engines you can use double quotes around a string to find the exact match.

Grouping

A big list of API specs is hardly ideal to work with as the specs you have are shared in your organization. To make it more manageable, you can put API specs into groups that mark up a category, or in essence anything you’d like.

To create a new group you can click the + button and give a name for your new group. To move API specs to your new group simply drag and drop them from their existing group into the new one.

Deleting

Nothing lives forever, not even API specs. You can delete API specs by selecting them and choose remove. This will move the API spec to the trash, which we’ll keep for 30 days. After that they’re deleted permanently. To search in the trash click Trash from the shortcut menu. Only the API specs that originally belonged to the group you were in when selecting trash are shown. From the trash you can also permanently delete API specs, but note that you cannot undo the deleting operation.

Got that one covered!