automadocs / solutions / api-documentation.md
00
Use case
API Documentation
Generate API references automatically. REST endpoints are auto-detected, while GraphQL and other protocols are analyzed by Claude. Content stays in sync with your code.
- REST
- Endpoints auto-detected
- GraphQL
- Analyzed by Claude
- Free tier
- 1 repo, 10 AI generations/month
01
What you get
Everything you need for reliable API references
- 01
Endpoint Detection
Automatically discovers REST endpoints from your codebase. Claude AI can also analyze GraphQL resolvers and RPC methods. - 02
Request/Response Examples
Generates realistic request and response examples based on your types and schemas. - 03
Authentication Guidance
Documents your auth flows, required headers, and token handling automatically. - 04
Auto-Sync
Pages update automatically when you push code changes. Avoid stale references after releases. - 05
Searchable Reference
Full-text search across all endpoints, parameters, and descriptions. - 06
Type Safety
Extracts types from TypeScript, JSDoc, Python type hints, and more.
02
Stack
Works With Your Stack
- Express.js
- FastAPI
- Django
- Rails
- Spring Boot
- Go
- GraphQL
- tRPC
- OpenAPI/Swagger
03
Standards
Quality Standards for API References
Teams that scale API adoption treat references as part of interface design. Every endpoint should include practical examples, explicit error behavior, and authentication requirements.
- 01
Intent First
Start each endpoint with use-case context so integrators understand when to use it. - 02
Error Contracts
Document error codes and recovery paths clearly to reduce failed integrations. - 03
Version Expectations
State deprecation windows and compatibility guarantees in plain language.