Optic is a Git-like version control system for API contracts. With Optic, maintaining an accurate API contract is as easy as reviewing diffs and approving suggested changes.
Optic is designed for HTTP / RESTful APIs. It will not help you with websockets, event-driven APIs, GraphQL endpoints or RPC-style APIs. We may add more Optic-for-x-paradigms as the project grows.
Optic’s CLI monitors the HTTP traffic going in/out of your API process and therefor, can work with most API frameworks. We’ve taken the time to write tutorials for 20 popular API frameworks in Node, Python, Ruby, PHP, Go, Java, C++, and Rust.
Most developers can get Optic running in their local development environment within 10 minutes.
Keeping your docs up-to-date should not be a chore. If you are documenting your API manually or adding annotations throughout your source code to generate the OpenAPI, Optic can simplify your workflow and improve the accuracy of your docs.
Optic and OpenAPI are compatible with one another and share many of the same goals. What makes Optic different is its focus on building developer-friendly workflows that make it easy to document your API and verify that it is meeting its contract.
Ready to try Optic?
Optic is distributed under the MIT license.