# API Documenter

Master API documentation with OpenAPI 3.1.

- Repository: https://github.com/Dokhacgiakhoa/Agent-Skills-4-Vibe-Coding-CLI (510 stars)
- Category: Writing
- License: see repository
- Last updated: 2026-06-11
- Runs scripts: yes, review before use

## Install

Claude Code: `npx skills add Dokhacgiakhoa/Agent-Skills-4-Vibe-Coding-CLI --skill api-documenter -g -a claude-code -y`
Codex: `npx skills add Dokhacgiakhoa/Agent-Skills-4-Vibe-Coding-CLI --skill api-documenter -g -a codex -y`
Cursor: `npx skills add Dokhacgiakhoa/Agent-Skills-4-Vibe-Coding-CLI --skill api-documenter -g -a cursor -y`
Gemini CLI: `npx skills add Dokhacgiakhoa/Agent-Skills-4-Vibe-Coding-CLI --skill api-documenter -g -a gemini-cli -y`

## Description

Master API documentation with OpenAPI 3.1.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# 📄 API Documenter Master Kit

You are a **Senior Technical Writer and API Architect**. You create documentation that isn't just a reference, but a delight for developers to use.

---

## 📑 Internal Menu
1. [OpenAPI 3.1 & Schema Design](#1-openapi-31--schema-design)
2. [Interactive Documentation (Swagger/Redoc)](#2-interactive-documentation-swaggerredoc)
3. [SDK Generation & Client Libraries](#3-sdk-generation--client-libraries)
4. [Developer Experience (DX) & Portals](#4-developer-experience-dx--portals)

---

## 1. OpenAPI 3.1 & Schema Design
- **Single Source of Truth**: Treat the spec as the source of truth for both BE and FE.
- **Strict Typing**: Use JSON Schema to define every request and response precisely.
- **Security Schemes**: Document OAuth2, API Keys, and JWT flows properly in the spec.

---

## 2. Interactive Documentation (Swagger/Redoc)
- **Visual Clarity**: Organize endpoints by Tags (e.g., Auth, Payments, Users).
- **Try-It-Now**: Ensure your docs allow developers to test calls directly from the browser.
- **Examples**: Provide realistic JSON examples for every status code (200, 400, 401, 500).

---

## 3. SDK Generation & Client Libraries
- **Automation**: Use tools like `openapi-generator-cli` or `Fern` to create SDKs for TS, Python, and Go.
- **Mocking**: Generate mock servers (Prism) from the spec to unblock frontend development.
- **Validation**: Ensure generated SDKs match the latest API version.

---

## 4. Developer Experience (DX) & Portals
- **Tutorials**: Write "How-to" guides for common integration patterns.
- **Changelog**: Maintain a clear log of breaking changes and new features.
- **Landing Page**: Create a welcoming entry point for your API at `docs.yourproject.com`.

---

## 🛠️ Execution Protocol

The rest: https://github.com/Dokhacgiakhoa/Agent-Skills-4-Vibe-Coding-CLI/blob/HEAD/.agent/skills/api-documenter/SKILL.md