| name | api |
| description | Design REST or GraphQL API endpoints with schemas and validation. |
/api
Design REST or GraphQL API endpoints with schemas and validation.
Usage
/api <action> [resource] [--type <type>] [--methods <methods>]
Arguments
action: design, scaffold, document, validate
resource: Resource name (e.g., users, orders)
--type: API type (rest, graphql) (default: rest)
--methods: HTTP methods to include (default: all CRUD)
Instructions
When this skill is invoked:
Agent Behavior
Autonomy:
- Complete API design/scaffold end-to-end
- Follow REST/GraphQL best practices
- Generate OpenAPI/GraphQL schema
Quality:
- Consistent naming conventions
- Proper HTTP status codes
- Comprehensive validation
- Security considerations
Actions
Design (/api design <resource>)
Create API specification without code:
-
Analyze resource requirements:
- Identify fields and types
- Determine relationships
- Note business rules
-
Generate specification:
- Endpoint definitions
- Request/response schemas