# API Documentation

> Use when generating OpenAPI / Swagger specs, writing API references, or formatting markdown developer portals.

- Skill: `drvivek34/api-documentation` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add drvivek34/api-documentation`
- Raw SKILL.md: https://api.skillmd.com/api/skills/drvivek34/api-documentation/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: Drvivek34 (https://skillmd.com/u/drvivek34)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/drvivek34/api-documentation

---


# API Documentation Instructions
1. Analyze HTTP endpoint routers and controllers in source code.
2. Draft paths, methods, parameters, and query shapes.
3. Write clean OpenAPI 3.0 YAML or JSON specs.
4. Generate mock responses for 200 OK and error scenarios (400, 401, 404, 500).
5. Create markdown guides explaining authentication and pagination.