API & Integration Documentation
Generate comprehensive API documentation with endpoint references, authentication guides, code examples, and integration tutorials.
Your API has 40 endpoints and the documentation is a Confluence page from 2023 that's missing half of them. Developers waste hours guessing at request formats, authentication headers, and error codes. Bad docs turn a 10-minute integration into a 3-day odyssey.
Who it's for: API developers who need to document endpoints for external consumers, platform teams maintaining developer documentation for integrations, developer relations engineers improving API onboarding experience, technical writers documenting REST and GraphQL APIs, startups preparing API docs for their first external partners
Example
"Document our REST API for external developers" → Complete API reference with all endpoints, request/response examples, authentication guide with token flow, error code reference, rate limit documentation, SDK code samples in 3 languages, and a quickstart integration tutorial
CLAUDE.md Template
New here? 3-minute setup guide → | Already set up? Copy the template below.
# 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
Get new playbooks like this one
One email a week with new Claude Code workflows. Free, like everything here.
No spam. Unsubscribe anytime.
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."