695 B
695 B
allowed-tools, description
| allowed-tools | description |
|---|---|
| Bash(find:*) | Generate API documentation for endpoints |
Context
- API routes: !
find . -path "*/routes/*" -name "*.js" -o -path "*/api/*" -name "*.js" | head -20 - Current API files: @$ARGUMENTS
Your task
Generate comprehensive API documentation including:
- Endpoint Overview: Method, URL, purpose
- Parameters: Query params, path params, request body
- Request Examples: Sample requests with curl
- Response Examples: Success and error responses
- Status Codes: All possible HTTP status codes
- Authentication: Required auth if applicable
Format as clear, readable documentation that can be used by other developers.