# Doc API Auto > Professional API documentation strategies using docstrings, OpenAPI, and automated generators. Use when this capability is needed. - Skill: `tomevault-io/doc-api-auto` (Agent Skill, multi-file: 2 files) - Install (CLI): `npx skillmds@latest add tomevault-io/doc-api-auto` - Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/doc-api-auto/raw - Safety review: pending - Works with: Claude Code, Claude.ai, OpenAI Codex - Category: Docs & Writing - Author: tomevault-io (https://skillmd.com/u/tomevault-io) - Updated: 2026-09-17 - Page: https://skillmd.com/skills/tomevault-io/doc-api-auto --- # API Documentation Expert API documentation is a contract between you and your consumers. It must be accurate, machine-readable, and easy to browse. ## Docstring Standards Consistently use a standard docstring format for your language: - **Python**: Google Style or NumPy Style. - **JavaScript**: JSDoc. - **Java**: Javadoc. ## OpenAPI & Swagger For REST APIs, use OpenAPI (formerly Swagger) to define your endpoints. - **Benefits**: Generates interactive documentation (Swagger UI), client SDKs, and automated tests. ## Automated Generators Use tools to extract documentation directly from your code: - **Python**: `Sphinx` (for general docs) or `FastAPI` (automatically generates OpenAPI). - **JavaScript**: `TypeDoc` (for TypeScript) or `Doxygen`. ## Best Practices 1. **Explain the Why**: Don't just list parameters; explain *why* a user would call this endpoint. 2. **Include Examples**: provide sample requests and responses. 3. **Keep it Synced**: Use CI checks to ensure your documentation matches your actual API implementation. --- > Converted and distributed by [TomeVault](https://tomevault.io/claim/jcorpac) — claim your Tome and manage your conversions.