Last updated Jul 17, 2024

What is the API feature?

The API feature helps your teams manage and quickly find specific endpoints associated with components in Compass. Developers can use the feature to easily reference accurate API documentation in a centralized location.

After you connect a code repository from either Bitbucket or GitHub, Compass automatically scans for associated API specifications in the background, then displays them within each component’s sidebar. How to import components from other apps

The feature is split into two helpful capabilities:

  • Endpoints: This table displays all endpoints associated with the component. It includes method, path, summary, and the date the endpoint was last updated.

  • Changelog: View endpoint changes over time with a chart visualization. You can track endpoints that have been added, changed, or removed, based on date, then select the hyperlinked path for more detail.

You must have full user permissions to access the API changelog. Understand user roles in Compass

Find the API details you need

When you view the API feature, you can browse and find the right endpoint to use in your work, and check when it was last synced so you know the accuracy of the API documenation. When you drill down into a specific endpoint, you can view relevant code snippets, responses, and requests

You can make documentation accessible to the developers who need it when they need it most, reducing the lead time it takes to find answers to questions about how the API works.

Review API specifications

When API specifications are added, Compass detects and highlights code errors in the newest version, which temporaily pauses the automatic scan. Once those errors are fixed in the source repository, the scan will resume.

This makes errors easier to fix, and helps ensure that your team’s API documentation is up-to-date, accurate, and in sync with your components in Compass.

How to use the API feature:

Rate this page: