Skip to content
api-documenter logo

📄 API Documenter Master Kit

api-documenter

Master API documentation with OpenAPI 3.1.

SKILL.md

Full skill instructions

📄 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
  2. Interactive Documentation (Swagger/​Redoc)
  3. SDK Generation & Client Libraries
  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.
    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.

More skills from Dokhacgiakhoa

nextjs-app-router-patterns logo
Dokhacgiakhoa/antigravity-ide

nextjs-app-router-patterns

Master Next.js 14+ App Router with Server Components, streaming, parallel routes, and advanced data fetching. Use when building Next.js applications, implementing SSR/SSG, or optimizing React Server Components.

507 0
View
startup-metrics-framework logo
Dokhacgiakhoa/antigravity-ide

startup-metrics-framework

This skill should be used when the user asks about "key startup

507 0
View
frontend-mobile-security-xss-scan logo
Dokhacgiakhoa/antigravity-ide

frontend-mobile-security-xss-scan

You are a frontend security specialist focusing on Cross-Site Scripting (XSS) vulnerability detection and prevention. Analyze React, Vue, Angular, and vanilla JavaScript code to identify injection poi

507 0
View
deployment-validation-config-validate logo
Dokhacgiakhoa/antigravity-ide

deployment-validation-config-validate

You are a configuration management expert specializing in validating, testing, and ensuring the correctness of application configurations. Create comprehensive validation schemas, implement configurat

507 0
View

This skill should be used when the user asks to "test for XSS vulnerabilities", "perform cross-site scripting attacks", "identify HTML injection flaws", "exploit client-side injection vulnerabilities", "steal cookies via XSS", or "bypass content security policies". It provides comprehensive techn...

507 0
View
nodejs-backend-patterns logo
Dokhacgiakhoa/antigravity-ide

nodejs-backend-patterns

Build production-ready Node.js backend services with Express/Fastify, implementing middleware patterns, error handling, authentication, database integration, and API design best practices. Use when creating Node.js servers, REST APIs, GraphQL backends, or microservices architectures.

507 0
View
projection-patterns logo
Dokhacgiakhoa/antigravity-ide

projection-patterns

Build read models and projections from event streams. Use when implementing CQRS read sides, building materialized views, or optimizing query performance in event-sourced systems.

507 0
View
backend-architect logo
Dokhacgiakhoa/antigravity-ide

backend-architect

Expert backend architect specializing in scalable API design,

507 0
View
seo-content-planner logo
Dokhacgiakhoa/antigravity-ide

seo-content-planner

Creates comprehensive content outlines and topic clusters for SEO.

507 0
View
llm-application-dev-langchain-agent logo
Dokhacgiakhoa/antigravity-ide

llm-application-dev-langchain-agent

You are an expert LangChain agent developer specializing in production-grade AI systems using LangChain 0.1+ and LangGraph.

507 0
View
personal-tool-builder logo
Dokhacgiakhoa/antigravity-ide

personal-tool-builder

Expert in building custom tools that solve your own problems first. The best products often start as personal tools - scratch your own itch, build for yourself, then discover others have the same itch. Covers rapid prototyping, local-first apps, CLI tools, scripts that grow into products, and the...

507 0
View

Popular AI tools

Kaiber logo
Video

Kaiber

Generate, edit, and beat-sync AI video with leading models in one workspace.

Paid
View
Vimcal logo
Productivity

Vimcal

The world's fastest calendar for remote work

Free
View

Transform Your Design with AI Designer by ImgCreator.ai

Freemium
View
Akool AI logo
Content & writing

Akool AI

Revolutionizing Video Production with AI-Powered Creativity

Paid
View

Extend an image past the frame and let AI fill the new aspect ratio.

Freemium
View
StarByFace logo
Security

StarByFace

Discover your celebrity doppelgänger with StarByFace!

Free
View
C

ChainClarity explains 700+ crypto whitepapers in plain English, with layered summaries, comparisons, research tools, alerts, and a $4.99 Pro plan.

Freemium
View
Opus Clip logo
Coding & apps

Opus Clip

Opus.ai: Revolutionize Your Web Experience

Free
View