How do I install the API Documenter skill?

Run npx skillmds add majiayu000/api-documenter-4 in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is API Documenter safe to use?

This skill has not completed SkillMD's automated safety review yet. Capability flags: docs only. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with API Documenter?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is API Documenter free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published API Documenter?

majiayu000 (@majiayu000) published this skill. Their other Agent Skills are listed on their SkillMD profile.

API Documenter by majiayu000 — Agent Skill

Name: API Documenter
Rating: 4.2 (5 reviews)
Author: majiayu000

API Documenter

Master API documentation with OpenAPI 3.1, AI-powered tools, and modern developer experience practices. Create interactive docs, generate SDKs, and build comprehensive developer portals.

majiayu000 fff72cd 2 files · 3.3 KB Updated Sep 9, 2026 567 repo stars

File contents

📄 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

OpenAPI 3.1 & Schema Design
Interactive Documentation (Swagger/Redoc)
SDK Generation & Client Libraries
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

Verify Spec: Run the internal validator to ensure OpenAPI integrity.

python .agent/skills/api-documenter/scripts/openapi_validator.py docs/openapi.json

Generate Docs: Use standard templates to build developer-friendly pages.
Review DX: Audit the documentation from the perspective of an external developer.
Distribution: Publish to the developer portal or internal hub.

Merged and optimized from 3 legacy API documentation skills.

---name: api-documenter-4description: Master API documentation with OpenAPI 3.1, AI-powered tools, and modern developer experience practices. Create interactive docs, generate SDKs, and build comprehensive developer portals.--- # 📄 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 1. **Verify Spec**: Run the internal validator to ensure OpenAPI integrity. ```bash python .agent/skills/api-documenter/scripts/openapi_validator.py docs/openapi.json ``` 2. **Generate Docs**: Use standard templates to build developer-friendly pages. 3. **Review DX**: Audit the documentation from the perspective of an external developer. 4. **Distribution**: Publish to the developer portal or internal hub. --- *Merged and optimized from 3 legacy API documentation skills.*

Frequently asked questions