skillist-io API Design
Use when designing or reviewing HTTP APIs, route naming, or OpenAPI specs.
When to activate
- New endpoint or resource design
- API consistency review
- Error response standardization
Procedure
- Model resources as nouns; use HTTP verbs for actions.
- Version via URL prefix (
/v1/) or header — pick one and document it. - Use consistent error envelope:
{ error, code, details? }. - Paginate list endpoints with
page,limit,total. - Document with OpenAPI; include examples for success and error cases.
Output format
- Resource diagram or route table
- Example request/response payloads
- Breaking-change notes if versioning