# Documentation API Documentation Best Practices > Imported TRAE skill from documentation/API_Documentation_Best_Practices.md Use when this capability is needed. - Skill: `tomevault-io/documentation-api-documentation-best-practices` (Agent Skill, multi-file: 2 files) - Install (CLI): `npx skillmds@latest add tomevault-io/documentation-api-documentation-best-practices` - Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/documentation-api-documentation-best-practices/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/documentation-api-documentation-best-practices --- # API Documentation Best Practices ## Overview Good API documentation is essential for developer experience and adoption. ## Tools - **Swagger/OpenAPI**: Standard for REST APIs. Auto-generate from code where possible. - **Postman Collections**: Shareable request collections. - **GraphiQL/Apollo Studio**: For GraphQL APIs. ## Content - **Authentication**: How to authenticate (Bearer, API Key). - **Endpoints**: Method, URL, Parameters. - **Request/Response Examples**: JSON bodies for success and error cases. - **Error Codes**: Explain standard error responses. --- > Source: [Ditto190/crispy-nextjs-turborepo-monorepo](https://github.com/Ditto190/crispy-nextjs-turborepo-monorepo) — distributed by [TomeVault](https://tomevault.io).