Launching API documentation you can subscribe to
Aidan Cunniffe 2023-03-06
Today Optic is launching our own API Catalog. We are focused on building a great documentation experience for companies with hundreds/thousands of internal API endpoints. Of course we are copying many of the styles and conventions from Stripe’s famous API docs (opens in a new tab). All that’s been done before — the exciting stuff is below the fold.
Get started 👇
npm install -g @useoptic/optic # install
optic login # login
optic api add --all # start tracking your OpenAPI files.
APIs are fast-becoming the most important dependencies between teams. There are good tools for versioning our libraries (package managers) and code (git), but versioning APIs requires new approaches. APIs are different from other kinds of software because changes affect your consumers the moment you release them. Consumers can't pin themselves to a version and integrate at their own pace.
Good API documentation helps a new consumer get integrated. Most API catalogs stop there, but that is just step one. The hard work comes next: helping consumers and producers communicate about API change and work together to achieve their goals. That is where most teams are struggling today and it is the part of the problem we think Optic can solve better than other tools. Because Optic understands how APIs change over time, our tool focuses on helping API-powered companies collaborate effectively, move faster, and ship amazing APIs.
A view of all the endpoints is useful when you are integrating (the first 1% of your API relationship), but it is not useful once your integration enters maintenance mode (99% of the relationship). Optic lets teams subscribe to each other’s API changes so they can be notified proactively about breaking changes and new functionality.
We’re also building stats into every API page, similar to how package managers have stats about each package. New consumers should be able to see how often each endpoint breaks, when it was last worked on, and who else in the company uses it.
Many developers struggle to work with OpenAPI and over time the specifications stop reflecting the API’s actual behavior.
Optic’s open source
verify command (opens in a new tab) ensures your OpenAPI specification is accurate. If it finds any issues, it even helps you resolve them — just pass in the
--patch flag and Optic will update the spec for you.
If you’re using the Optic API Catalog the accuracy of each endpoint in is tracked in the UI. You can see which API docs are accurate, and track improvements to your portfolio of APIs over time. We are committed to helping your team publish the most accurate and relevant API Catalog.
We want to make it easy to work with your team’s APIs, but we also want to help teams make their APIs better over time. We’ve found the simplest and highest leverage practice any team can start doing are simple API reviews (like a code review) whenever changes are made (opens in a new tab).
Changes to OpenAPI specs (2-10k line YAML files) are difficult to review. One line of OpenAPI can be a breaking change to multiple endpoints — you’d never know just looking at the line without its context. Optic adds a visual, easy-to-review, changelog to every Pull Request that changes one of your APIs. Teams that use Optic in CI release 12x fewer breaking changes than they did before, and report shipping better API designs. The impact is even greater if they have an API Style Guide built with Spectral (opens in a new tab), ReDocly (opens in a new tab) or Optic (opens in a new tab).