api-designer
Design RESTful APIs with best practices for consistency and usability
Packaged view
This page reorganizes the original catalog entry around fit, installability, and workflow context first. The original raw source lives below.
Install command
npx @skill-hub/cli install athola-skrills-api-designer
Repository
Skill path: assets/demo-skills/api-designer
Design RESTful APIs with best practices for consistency and usability
Open repositoryBest for
Primary workflow: Ship Full Stack.
Technical facets: Full Stack, Backend, Designer.
Target audience: everyone.
License: Unknown.
Original source
Catalog source: SkillHub Club.
Repository owner: athola.
This is still a mirrored public skill entry. Review the repository before installing into production workflows.
What it helps with
- Install api-designer into Claude Code, Codex CLI, Gemini CLI, or OpenCode workflows
- Review https://github.com/athola/skrills before adding api-designer to shared team environments
- Use api-designer for development workflows
Works across
Favorites: 0.
Sub-skills: 0.
Aggregator: No.
Original source / Raw SKILL.md
--- name: api-designer description: Design RESTful APIs with best practices for consistency and usability --- # API Designer Expert guidance for designing clean, consistent REST APIs. ## REST Principles - Use nouns for resources, verbs for actions - Follow HTTP method semantics (GET, POST, PUT, DELETE) - Return appropriate status codes - Support content negotiation ## URL Design - Use plural nouns for collections (/users, /posts) - Nest resources logically (/users/123/posts) - Use query parameters for filtering and pagination - Keep URLs readable and predictable ## Response Format - Use consistent JSON structure - Include metadata for collections (total, page, etc.) - Provide helpful error messages - Support partial responses when needed ## Versioning - Include version in URL or header - Maintain backward compatibility - Document breaking changes clearly - Deprecate gracefully with notice periods ## Security - Use HTTPS everywhere - Implement proper authentication - Validate all inputs - Rate limit API endpoints - Log security-relevant events ## Documentation - Provide OpenAPI/Swagger specs - Include request/response examples - Document error codes and meanings - Keep docs updated with changes