Skip to main content

Start working API-first

Adopting OpenAPI and working API-first asks a lot of developers. Optic's open source tools make it easy for every team to track, review and test their API changes.

Snyl

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
Snyl

To deliver a stable and 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

Optic diffs API behavior, and makes it easy to test your API changes

Pass/Fail each API change

Optic lets you write tests about how your API can change. Use CI to catch breaking changes, enforce your versioning policies, and check that other API standards are followed.

Manually Review API Design

Optic adds a visual API changelog to each Pull Request so you do not have to convert a line diff to an API diff in your head. Changelogs help kickstart and support effective API reviews on your team.


Run an API diff with the CLI
Loading...

Go beyond API linting. Start testing your API changes

API linting works great when you are designing a brand new API, but linting breaks down once you have shipped. Once you publish the API, how do you detect/prevent breaking changes? How do you make sure your versioning policy is being followed? How do you evolve the API standards over time?

Instead of linting an OpenAPI file, Optic lets you write tests about each change you make to the API. Teams like Snyk have turned off their linters and adopted Optic's approach to achieve higher quality, consistency and reliability across their APIs

Learn more about Testing Changes
Teams that test changes:
Ship 98% fewer breaking changes
Design APIs that are 4x more consistent
Automate checks for 8x as many API standards

API Reviews happen within your current tools

Optic integrates with GitHub and GitLab. Whenever a Pull Request includes API changes, an API review is kicked off. Visual Changelogs are generated and posted in a comment, and a seperate CI process tests your API changes.

Add Optic to your Pull Requests

All your API changes in one place

Optic Cloud catalogues APIs from from across your organization and makes them visible from one dashboard. Get alerted on Pending API Changes, Recent API Changes, and new APIs that come online.

Discover all your APIs

Quick Start

Optic's open source tools make it easy to adopt OpenAPI, keep your specs up-to-date, and review APIs changes. Try out some of the CLI Commands to see what Optic is all about.

Visualize API Changes

Optic makes Reviewing a teammate's proposed API changes easy. Optic shows the effective API changes being proposed, not the line diff.
optic diff openapi.yml --base main --web

Check for breaking changes

Optic can detect backwards incompatible changes during development or in CI making it much easier to keep your promises to consumers.

Keep your OpenAPI up-to-date

Make an API change? Optic can help you track that change in OpenAPI so your team can give feedback, and your docs stay up-to-date

Create an initial OpenAPI from traffic

Imagine 'git add -a' but for your API Operations. Show Optic API traffic from your development environment and it will write all the boilerplate OpenAPI for you.