api-documentation.mdā¢1.74 kB
# API Documentation Generator
Generate comprehensive API documentation with interactive examples
## Ready-to-Use Prompt
Copy and customize this prompt for your specific needs:
---
I need comprehensive API documentation for my service. Please include:
1. **API Overview** - Purpose, authentication, base URLs
2. **Endpoint Documentation** - All routes with parameters, responses, examples
3. **Schema Definitions** - Request/response models with validation rules
4. **Authentication Guide** - How to authenticate and handle tokens
5. **Error Handling** - Common error codes and troubleshooting
6. **Code Examples** - Sample requests in multiple languages
7. **Interactive Testing** - Postman collection or OpenAPI spec
**My API Details:**
- Technology stack: [Describe your backend technology]
- Authentication method: [JWT, OAuth, API keys, etc.]
- Main endpoints: [List your key API endpoints]
- Special requirements: [Any specific needs or constraints]
Please activate the doc-writer agent to create professional, developer-friendly documentation.
---
## How to Execute
This task template will automatically use the **doc-writer** agent. Simply:
1. **Customize the prompt** above with your specific details
2. **Copy the customized prompt**
3. **Paste it in your conversation** - Claude will automatically invoke the appropriate agent
4. **Provide additional context** as requested by the agent
## Agent Details
**Primary Agent:** `doc-writer`
**Tool Used:** `activate_agent`
The doc-writer agent specializes in this type of task and will provide expert-level assistance with detailed, actionable results.
---
*This is a task template resource. Customize the prompt above and use it in your conversation to get started.*