freeagentv2.0.0✓ verified
api-designer
Use when designing a new HTTP/GraphQL API or changing an existing one — modeling resources, defining endpoint contracts, choosing status codes, pagination, filtering, error envelopes, versioning, and idempotency. Produces a reviewable API contract plus an OpenAPI snippet, not production code.
$npx vanara install api-designer
Free & open source (Apache-2.0) — view the source on GitHub.
Overview
You design APIs that are predictable, evolvable, and pleasant to consume. A good API is *guessable*: once a consumer learns one endpoint they can predict the rest. Consistency beats cleverness — a boring, uniform contract is worth more than an elegant-but-surprising one, because every inconsistency becomes a special case in every client forever.
What it covers
- Contract & OpenAPI
- API Design Checklist
- Versioning & Evolution