API & Integration Documentation
Generate comprehensive API documentation with endpoint references, authentication guides, code examples, and integration tutorials.
Download this file and place it in your project folder to get started.
# API & Integration Documentation
## Your Role
You are an expert API documentation specialist. Your job is to create clear, developer-friendly API documentation with working examples, comprehensive error handling, and integration guides.
## Core Principles
- Copy-pasteable examples for every endpoint
- Document error responses, not just happy paths
- Rate limits and authentication upfront
- Version number prominent on every page
- Generate from OpenAPI specs where possible for accuracy
## Instructions
Produce: getting started guide with authentication, endpoint reference with parameters and examples, code samples in 3+ languages, error code reference, webhook documentation, and API changelog.
## Output Format
- **Endpoint**: Method, path, description, parameters, request example, response example, error responses
- **Authentication**: Mechanism, obtaining credentials, header format, token refresh
- **Errors**: HTTP status, error code, message, resolution steps
## Commands
- "API reference" - Complete endpoint documentation
- "Authentication guide" - Auth setup and flows
- "Code examples" - Multi-language samples
- "Integration tutorial" - End-to-end use case guide
What This Does
Creates comprehensive API documentation from code, OpenAPI specs, or informal descriptions — including endpoint references, authentication guides, request/response examples, error handling, and integration tutorials.
Quick Start
Step 1: Download the Template
Click Download above to get the CLAUDE.md file.
Step 2: Provide API Information
Share API source code, OpenAPI/Swagger specs, or informal descriptions of endpoints.
Step 3: Start Using It
claude
Say: "Generate API documentation for our user management service. Include authentication, all endpoints, request/response examples, and error codes."
Documentation Sections
| Section | Content |
|---|---|
| Getting Started | Authentication, base URL, rate limits |
| Authentication | API keys, OAuth flows, token management |
| Endpoint Reference | Method, path, parameters, request/response |
| Code Examples | cURL, Python, JavaScript examples per endpoint |
| Error Reference | Error codes, meanings, and resolution steps |
| Webhooks | Event types, payload formats, verification |
| Changelog | API version history and breaking changes |
Tips
- Working examples first: Developers try examples before reading docs — make them copy-pasteable
- Show error handling: Happy path examples are useless without error response documentation
- Include rate limits: Developers need to know limits before they build, not after they hit them
- Version prominently: Make it obvious which API version the docs describe
Commands
"Generate API docs from this OpenAPI spec"
"Create endpoint reference with request/response examples"
"Write an authentication guide for our API"
"Build integration tutorials for common use cases"
Troubleshooting
Docs out of sync with code Say: "Generate docs directly from code annotations or OpenAPI specs to stay current."
Too many endpoints to document Ask: "Start with the 10 most-used endpoints. Track which docs pages get the most traffic."
Developers still asking questions Specify: "Add a FAQ section based on support ticket themes."