Api design first
AI-agent skills for software engineering — works with Claude Code, Codex, Cursor
npx -y skills add vaibhavsaxena022/skills --skill api-design-firstAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
2 things to look at
- 23 days oldThe repository was created 23 days ago. New is not bad, but a brand new repository carrying a familiar-sounding name is the shape a typosquat arrives in, and there has been no time for anyone else to find a problem with it.
- 0 stars0 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
What its author says it does
Copied from the file, not written here
Design a REST API contract before implementing it. Use when adding a new API or resource. Defines resources, endpoints, request/response shapes, status codes, errors, and versioning up front, then confirms before any code.
SKILL.md
1.3 KB, as published. Nobody here has run it
API Design First
Agree on the contract before writing the implementation.
Steps
- Model the resource(s) and their lifecycle.
- Define the endpoints: verb + path, purpose, auth, idempotency.
- Specify request/response DTOs with types and required/optional fields.
- Define status codes per endpoint and the shared error response shape.
- Address pagination, filtering, versioning, and rate limits where relevant.
- Present the contract (or an OpenAPI sketch) for confirmation before implementing.
Rules
- Nouns for resources, plural collections, correct HTTP verbs.
- Design for evolution: additive changes by default; explicit versioning for breaking ones.
- Consistent naming, error shape, and pagination across all endpoints.
- Never expose internal entities directly — use DTOs.