# opticdev/optic

OpenAPI linting, diffing and testing. Optic helps prevent breaking changes, publish accurate documentation and improve the design of your APIs.

Repository: https://github.com/opticdev/optic
Canonical: https://ross.abutalabs.com/products/optic
Language: TypeScript
License: MIT
License Family: permissive
Topics: openapi, apis, documentation, swagger, openapi3, api-documentation, api-linter
Archived: true
Last push: 2026-01-08T21:11:15+00:00

## Health v2 (maintenance only)
Score: 10/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 61, release rhythm 30, longevity 100
- inputs: {"age_days": 3106, "days_push": 237, "days_rel": 388, "gap_med": 87, "n_releases_24m": 6}
- flags: archived
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1535, forks 96 (observed 2026-08-28T04:04:59.749009+00:00)

## What it is
Optic is a CLI tool for linting, diffing, and testing OpenAPI specifications. It catches breaking changes, generates specs from traffic, and keeps API documentation accurate.

## Use cases
- lint openapi specs for design issues
- detect breaking changes in api before release
- generate openapi spec from captured traffic
- keep swagger documentation accurate with automated tests
- diff two openapi versions in ci
- enforce api design rules across a team

## When to choose
- your team maintains an OpenAPI spec and wants to prevent breaking changes
- you need automated API contract checks in CI
- your documentation drifts from actual API behavior

## When to avoid
- you don't use OpenAPI/Swagger to describe your APIs
- you need a GUI-only API design tool
- you want runtime API monitoring rather than spec-level checks

## Facets
- artifact type: cli-tool
- maturity: active
- function: api-framework, documentation, testing, linter, developer-tools
- domain: apis, developer-tools, documentation, web-development
- platform: cli, cross-platform
- tags: openapi, swagger, api-linting, breaking-changes, api-diffing, spec-testing, nodejs

## Member repositories
- opticdev/optic (main) score 10

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:04:59.749009+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T04:31:10.085560+00:00, confidence not recorded.
  - readme: https://github.com/opticdev/optic (fetched 2026-08-28T04:04:59.749009+00:00, sha 0bc276802e92)
- Data as of 2026-08-30T08:39:29.467469+00:00.