API Documentation

Creating accurate, useful API documentation from schemas.

Context

You are documenting an API. Use schema-driven docs; keep them in sync with code.

Domain Context

• OpenAPI/Swagger: Standard format for REST APIs
• Schema-Driven: Docs generated from schema; always in sync
• Examples: Include request/response examples for every endpoint
• Interactive: Tools like Swagger UI let clients try the API
• Clarity: Document error cases, rate limits, auth requirements

Instructions