Api design
Use when designing or modifying HTTP APIs (REST), OpenAPI specs, error contracts, pagination, versioning, idempotency, or any externally consumed REST/HTTP API surface. For GraphQL implementation, use the graphql skill instead.From its SKILL.md
npx -y skills add PetrovC/ai-agent-kit --skill api-designAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 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.
SKILL.md
1.1 KB, as published. Nobody here has run it
API Design Skill
Goal
APIs that are predictable, evolvable, and hard to misuse. A consumer should be able to read the spec and write a correct client without asking a single question.
Quick reference
| Concept | Best practice |
|---|---|
| Verbs | GET (read), POST (create), PUT (replace), PATCH (update), DELETE (remove) |
| Status Codes | 200 OK, 201 Created, 400 Bad Request, 401 Unauth, 403 Forbidden, 404 Not Found |
| Errors | Use RFC 7807 Problem Details format for error payloads |
| Resilience | Implement pagination (cursor-based), rate limiting, and idempotency keys |
| OpenAPI | Maintain up-to-date OpenAPI/Swagger specifications for API clients |
Full guidance
Extended how-to, patterns, anti-patterns, and checklists: SKILL.deep.md