# API Docs

> Create clear, accurate, and comprehensive API documentation. Use when this capability is needed.

- Skill: `tomevault-io/api-docs-2` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/api-docs-2`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/api-docs-2/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- 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/api-docs-2

---


# API Documentation Skill

## Purpose
Create clear, accurate, and comprehensive API documentation.

## Documentation Components

### 1. Overview
- API purpose and capabilities
- Authentication requirements
- Base URL and versioning
- Rate limits and quotas

### 2. Endpoint Documentation
- HTTP method and path
- Request parameters (path, query, body)
- Request/response examples
- Error responses and codes
- Authentication requirements

### 3. Code Examples
- Multiple language examples (curl, JavaScript, Python)
- Complete, runnable snippets
- Common use case scenarios

## Best Practices

1. **Be Accurate** - Documentation must match actual behavior
2. **Use Examples** - Real request/response pairs
3. **Explain Errors** - Document all error codes and recovery steps
4. **Version Clearly** - Note API version and deprecations
5. **Keep Updated** - Update docs with every API change

## Format Standards

- OpenAPI/Swagger for REST APIs
- GraphQL schema for GraphQL APIs
- JSDoc/TSDoc for library functions

---
> Converted and distributed by [TomeVault](https://tomevault.io/claim/hffmnnj) — claim your Tome and manage your conversions.
<!-- tomevault:4.0:skill_md:2026-04-11 -->