Api design
Small, harness-neutral engineering skills for coding agents
npx -y skills add kevinb361/agent-skills --skill api-designAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
3 things to look at
- 13 days oldThe repository was created 13 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.
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
- 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 or review HTTP APIs for resource shape, versioning, authentication, authorization, errors, pagination, idempotency, caching, and evolvability. Use when adding or changing an HTTP surface.
SKILL.md
1.2 KB, as published. Nobody here has run it
HTTP API design
Start with consumers, operations, trust boundaries, and compatibility constraints. Define resources and behavior before endpoint syntax.
Cover the relevant contract:
- methods, paths, status codes, and content types
- request and response schemas
- validation and stable error shape
- authentication and per-resource authorization
- pagination, filtering, sorting, and bounded limits
- idempotency and retry behavior
- concurrency controls and conditional requests
- caching and rate limits
- observability without secret leakage
- versioning, deprecation, and migration
Prefer boring HTTP semantics and explicit limits. Avoid action-heavy endpoint collections when a resource model is clearer. Distinguish absent, empty, unauthorized, forbidden, conflicted, and temporarily unavailable states.
For a review, cite concrete contract defects and compatibility risks. For a new design, include representative requests, responses, errors, and the decisions consumers must rely on.