// Streamline your API development experience//
Optic CLI knows how to diff, test, lint and update your OpenAPI specs.
Checkout what Optic can do for you:
Prevent breaking changes
Optic can detect breaking changes between any two versions of an OpenAPI specification. Run the optic diff command in CI and never break your API contract again.
Test the accuracy of your documentation
Optic tests that your API docs are accurate by capturing the HTTP traffic in your tests and comparing it to your OpenAPI spec. Add Optic to your CI to improve the accuracy of your docs and gain your consumers trust.
Keep your specs up to date
Optic can automatically document API changes as you work. Optic records your test traffic and updates the OpenAPI to reflect what you have been working on. The CLI figures out exactly which lines of OpenAPI need to be updated and makes the changes for you.
Improve your API design
Optic is an API linter that does not get in the way. Make sure new endpoints follow the latest standards, while being more relaxed with APIs that have already shipped. Fully compatible with Spectral, Redocly and other API Linting tools.
// Optic CI flow //
Running Optic in CI helps you ship better APIs without disturbing your team's workflow. Getting started is as easy as running optic ci setup. Read more about Optic CI.
- OpenAPI is accurate
- ⦿
- No Breaking Changes
- ⦿
- New Endpoints follow v3 API Guidelines
- ⦿
As you ship code, Optic updates your API changelog and docs so they are always up-to-date.
With OpenAPI changes
Tests HTTP traffic gets recorded
Optic CI Checks Run:
With Optic Cloud:
// What people are saying //
