// 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.

Product screenshot

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.

Product screenshot

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.

Product screenshot

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.

Product screenshot

// 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.

Testing API Changes
OpenAPI is accurate
No Breaking Changes
New Endpoints follow v3 API Guidelines
Added 3 Endpoints. Changed 4 endpoints.

As you ship code, Optic updates your API changelog and docs so they are always up-to-date.

Open Pull Request
With OpenAPI changes
Run your CI Test Suite
Tests HTTP traffic gets recorded
Optic CI Checks Run:
No Breaking changes
API design is consistent
OpenAPI is accurate
API Test Coverage
With Optic Cloud:
Preview Documentation in PR
Visual API Changelog in PR
API Catalogue updated
Consumers notified about changes
API Stats + Scores updated

// What people are saying //

"We are set up to provide a great API and an amazing developer experience to our consumers. Realizing the promise of OpenAPI has always been hard. Optic's tools made it easier to get developers on-board and start fulfilling the promises of working API-first."
Gary Poster Senior Director Engineering
"To deliver a high quality API we need to be working API-first, and keeping track of the promises we have made to consumers. API-first has always been hard, Optic is the first tool we have found that makes it easy to quickly build and safety extend our APIs. "
Kostas Petrakis Lead API Engineer
"Anyone using (or wanting to use) OpenAPI to describe APIs should take a strong look at Optic. They truly get what it takes to maintain a great API at scale 🧑‍🍳🤌"
Marc-André Giroux API Lead
"Optic is a smart, simple, and straightforward solution to a real world problem every company faces"
Kin Lane API Evangelist
"Brilliant! That's a whole lot of OpenAPI I don't need to write, and Optic is even making components to keep your OpenAPI Dry."
Phil Sturgeon Author, APIs you Won't Hate