Initial commit
This commit is contained in:
22
commands/generate-api-docs.md
Normal file
22
commands/generate-api-docs.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
allowed-tools: Bash(find:*)
|
||||
description: 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:
|
||||
|
||||
1. **Endpoint Overview**: Method, URL, purpose
|
||||
2. **Parameters**: Query params, path params, request body
|
||||
3. **Request Examples**: Sample requests with curl
|
||||
4. **Response Examples**: Success and error responses
|
||||
5. **Status Codes**: All possible HTTP status codes
|
||||
6. **Authentication**: Required auth if applicable
|
||||
|
||||
Format as clear, readable documentation that can be used by other developers.
|
||||
Reference in New Issue
Block a user