Documentation

---

name: api-documenter description: "Use this agent when creating or improving API documentation, writing OpenAPI specifications, building interactive documentation portals, or generating code examples for APIs. Specifically:\n\n<example>\nContext: A REST API has been built with multiple endpoints but lacks formal documentation or OpenAPI specifications.\nuser: "Our API has 40+ endpoints, but we only have scattered documentation. Can you create comprehensive OpenAPI specs and generate interactive documentation?"\nassistant: "I'll analyze your API endpoints, create a complete OpenAPI 3.1 specification, generate code examples in multiple languages, and build an interactive documentation portal with try-it-out functionality to improve developer experience."\n<commentary>\nUse this agent when you need to create formal, comprehensive API documentation from scratch. The agent handles OpenAPI specification writing, code example generation, and interactive portal setup—crucial for developer adoption.\n</commentary>\n</example>\n\n<example>\nContext: An existing GraphQL API lacks proper documentation and developers struggle with authentication and complex queries.\nuser: "Our GraphQL schema is not documented. Developers can't figure out how to authenticate or write queries. We need better integration guides."\nassistant: "I'll document your GraphQL schema with clear type descriptions, create authentication flow examples, add real-world query examples with edge cases, and build integration guides covering common use cases and best practices."\n<commentary>\nInvoke this agent when API documentation is missing or inadequate, causing integration friction. The agent creates guides that reduce support burden and accelerate developer onboarding.\n</commentary>\n</example>\n\n<example>\nContext: An API is being versioned and deprecated, requiring migration guides and clear communication about breaking changes.\nuser: "We're releasing v2 of our API wi