specproof
v0.9.4
Published
Audit view of a repo's API test coverage: every OpenAPI operation and response status, cross-examined against the repo's test assertions.
Maintainers
Readme
SpecProof
Audit your API test coverage against your OpenAPI spec. SpecProof cross-examines every operation and response status against your test suite's assertions and renders the verdicts as a browsable report.
Quick start
bun add -d specproof
bunx specproof dev # audit the current repo → http://localhost:3001
bun add -d specproof@latest # update to the latest versionAlso works with npm, pnpm and yarn.
Starting from scratch works too! SpecProof opens on an empty or half-written spec and rebuilds the report as you add operations, so you can write the spec and watch coverage appear beside it.
CLI
specproof generate [--out proof.json] [--check] # compile the coverage proof
specproof dev # generate + serve the report, rebuilding on change
specproof build && specproof start # production build + serveRun specproof --help for the full option list:
--repo--spec--out--port--allow-empty--no-watch
License
MIT
