api-design
Design API endpoints, schemas, and contracts. Use when defining public interfaces or data models.
Installation
Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.
View source ↗GuidesSkill instructions
API Design
Define the interface contracts for APIs, including endpoints, request/response schemas, and error handling.
Process
- Review spec.md and architecture.md
- Define endpoints and HTTP methods
- Design request and response schemas
- Define error responses and codes
- Consider versioning strategy
Output
Create api-design.md using the template in templates/api-design.md.
Tips
- Use consistent naming conventions
- Design for backwards compatibility
- Include example payloads
- Document rate limits if applicable
- Consider pagination for list endpoints
Examples
Read the usage examples in the source repository.
View source ↗Source history
- Indexed on
- 2026-01-20
- Index updated
- 2026-02-04
- Branch
- main
Index and sync dates describe this directory. View the source repository for code history.
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!