Track a new endpoint

Optic makes it easy for everyone on your team to tracktrack - Tracking a change involves using evidence of behavior change to create a proposal. Evidence is gathered from real traffic, such as from live environments or the Optic Capture Toolkit. Tracking changes is common in code-first workflows. new API endpoints without needing to learn OpenAPI.

Tracking a new endpoint

  1. In your API project in the Optic Cloud, click Add Endpoint.

  2. Choose a method for tracking an endpoint. The Optic UI will guide you through collecting the information necessary to define your endpoint's behavior. Feel free to check out using the Capture Toolkit to see some of the options available for using traffic to track your endpoint.

  3. Optic will report on the details of the captured traffic, including the request and response payloads and query parameters. Review the documentation and make any minor corrections as needed.

  4. Add a descriptive commit message and click Finish.

What your team sees during code review

By connecting your API lifecycle to your code changes, Optic is able to add accurate API changelogs to every Pull Request that affects the API.

When the team clicks "View Changelog" it will link them to the new endpoint's documentation that Optic helped you author a few minutes earlier.


Did this page help you?