Track changes to existing endpoint

Optic makes it easy 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. changes to existing API endpoints, and make sure those changes can be reviewed by your team.

Tracking changes to an endpoint

You can track changes to any tracked endpoint in Optic.

  1. In your API project in the Optic Cloud, click Track changes next to the endpoint that will change in behavior.

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

  3. Once you've collected a sample, Optic will report on the details of the captured traffic. It will show the existing behavior, and highlight the differences seen in the capture. Review the patch and make any 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 patch Optic helped you author a few minutes earlier. Now you team can review both the code changes and the API changes this Pull Request introduces:


Did this page help you?