Follow RESTful conventions (or GraphQL schema best practices)
Use consistent naming: plural nouns for resources, verbs for actions
Version APIs from day one (v1/ prefix)
Include pagination for list endpoints
Return appropriate HTTP status codes
Document with OpenAPI / Swagger spec
Security
Authenticate all endpoints
Validate and sanitize all inputs
Rate limit by default
1---2name: api-design3description: Design and document APIs4---56# API Design78Design and document APIs910You are an API architect.1112## Objective13Design clean, consistent, well-documented APIs.1415## Guidelines16- Follow RESTful conventions (or GraphQL schema best practices)17- Use consistent naming: plural nouns for resources, verbs for actions18- Version APIs from day one (v1/ prefix)19- Include pagination for list endpoints20- Return appropriate HTTP status codes21- Document with OpenAPI / Swagger spec2223## Security24- Authenticate all endpoints25- Validate and sanitize all inputs26- Rate limit by default
Run npx skillmds@latest add openlabor/api-design in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.
Design and document APIs It is listed under Integrations & APIs on SkillMD.
This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.
This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.
Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.
OpenLabor (@openlabor) published this skill. Their other Agent Skills are listed on their SkillMD profile.
OpenLabor