# API Documentation

> Generate comprehensive API documentation following OpenAPI 3.0 and REST standards when creating or documenting APIs, endpoints, or web services Use when this capability is needed.

- Skill: `tomevault-io/api-documentation-5` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/api-documentation-5`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/api-documentation-5/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/api-documentation-5

---


# API Documentation Skill

Generate professional API documentation following industry standards.

## OpenAPI 3.0 Format

```yaml
openapi: 3.0.0
info:
  title: Your API Name
  version: 1.0.0
  description: Clear API description

servers:
  - url: https://api.example.com/v1

paths:
  /users:
    get:
      summary: List all users
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'

components:
  schemas:
    User:
      type: object
      required:
        - id
        - email
      properties:
        id:
          type: string
        email:
          type: string
```

## Documentation Checklist

- [ ] Endpoint path and HTTP method
- [ ] Clear summary (1 line)
- [ ] Detailed description (2-3 sentences)
- [ ] All query/path/header parameters documented
- [ ] Request body schema (if applicable)
- [ ] All response status codes
- [ ] Response schemas
- [ ] Authentication requirements
- [ ] Rate limiting information
- [ ] Example requests and responses

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