sills-audit-api-design

Evaluate whether an API is predictable for consumers, faithful to its contract, and safe to evolve.

Install

npx sills-audit-api-design install

Use

$sills-audit-api-design Audit this project.

What it inspects

Specifications and schemas, resource and operation modelling, naming, types, validation, errors, status and error codes, pagination, filtering, sorting, search, idempotency, retries, concurrency, caching, authentication, authorization, tenancy, rate limits, versioning, deprecation, compatibility, webhooks, events, SDKs, examples, documentation, observability, SLIs, and implementation drift.

What it gives you

A dated specialist report, structured findings, coverage inventory, evidence, positive findings, limitations, prioritised recommendations, verification instructions, and remediation handoff. It never changes the audited product.

Modes

source, runtime, full, changed, ci, and verify, with quick, standard, and deep depth profiles.