Skip to main content

API discovery

Optic Cloud can search all the Repositories it has access to for OpenAPI descriptions.

When your team first adds Optic, discovery makes set up very quick:

  1. Inventorying all your APIs and understanding the current state of your organization's APIs. Results show up within minutes, can take 3-5 hours to complete a full inventory because of Search API rate limits.
  2. Enabling visual API diffs on Pull Requests so developers can understand their API changes better.

After your team has adopted Optic, discovery makes sure new APIs are brought to your attention:

Adding an API

On the "APIs" page you'll see 3 tabs:

  • Tracking Changes - The APIs Optic is tracking. When they change, you'll see them in your Optic dashboard. The developers building these APIs see changelogs and whatever API Standards you configure with them.
  • Newly Discovered - new OpenAPI Optic has detected. Might indicate an entirely new API, new microservice, or major version.
  • Disabled - these are OpenAPI files that you have silenced / ignored. Optic will not track these.

When new OpenAPI files are added to your repositories, they appear on this page. You can see the filepath, the title, and the repository. These will link you directly to the specification in GitHub or GitLab if you need to investigate it further.

If you decide to start tracking this API, Optic will ask you to set its standards and decide whether issues should block the team's CI pipeline. By default, Optic does not get in the way of developer workflows. Once a team matures and is working API-first, it can make sense (and many will ask you), to enable stricter checks. You can always change these settings.