Repository files navigation

npm install @useoptic/optic

Optic helps you keep your OpenAPI specification accurate. Your API tests are run through Optic's proxy. When existing endpoints have changed, Optic lets you know and makes it easy to patch the specification. When new endpoints are added, Optic helps you document them.

Run this command:

optic capture openapi.yml

This will run some tests and tell you about the API diffs it observed. It will exit 1 (like a snapshot test) because the spec is out of date.

Now run it again with the--update flag.

optic capture openapi.yml --update interactive

• The CLI will ask you if you want to document and start tracking the behavior of the newGET /author/{author_id} in your OpenAPI specification. Say yes.
• The CLI will patch the schemas to resolve the previous errors. Now your spec is up-to-date!

Optic'sdiff command tests that API changes are backwards compatible, and that new and existing API endpoints follow your style guide. The style guide is configured in theoptic.yml file.

Compute a diff:

optic diff openapi.yml --check --web

A visual API Changelog is generated and opened in your browser. It shows you exactly which endpoints were changed, and flags any design or compatibility issues:

Optic is designed to run in Pull Requests and give developers actionable feedback on their APIs changes before they merge. You can see what this looks like by runningoptic run locally. It finds all the OpenAPI specifications in your repository, checks that the specs are accurate, and then runs the breaking change + governance checks.

optic run

You'll see a link to the changelog in the CI output and a link to your API documentation on Optic Cloud:

This repo has example CI workflows for GitLab (.gitlab-ci.yml) and GitHub (.github/workflows/optic.yml) that show how to set up Optic in your CI pipeline.Full instructions are here