This API documentation prompt configures an AI agent to generate developer-friendly API reference documentation that goes beyond auto-generated specs to provide the context and examples that developers actually need. The prompt emphasizes completeness, accuracy, and practical usability with realistic examples that demonstrate common use cases and edge cases.
The template guides documentation structure for RESTful APIs: clear endpoint descriptions explaining what each endpoint does and when to use it, comprehensive parameter tables with types and validation rules, authentication and authorization requirements, request/response examples in multiple formats (curl, JavaScript, Python), error response documentation with troubleshooting guidance, and rate limiting or quota information.
Key capabilities include generating realistic example payloads that demonstrate actual usage patterns rather than minimal toy examples, documenting implicit behaviors and defaults that aren’t obvious from parameter lists alone, explaining the relationship between related endpoints, providing guidance on pagination and filtering patterns, and including code snippets that show complete, working integration examples.
The generator follows API documentation best practices including describing response schemas with nested object structures clearly documented, noting which fields are always present vs. conditional, explaining enum values and their meanings, documenting side effects and state changes, and providing quick-start guides that get developers to a working integration quickly before diving into comprehensive reference material.