bnloading/newshaqyrus/api-documenter

Claude Code and agent skill by bnloading/newshaqyrus

Trust tier 3
  • community
Source check pending

Checking that the SKILL.md file is still in the repository.

Master API documentation with OpenAPI 3.1.

Install

npx vskill@latest install bnloading/newshaqyrus/api-documenter

SKILL.md

The same SKILL.md was published earlier as dokhacgiakhoa/agent-skills-4-vibe-coding-cli/api-documenter.

📄 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.

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

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

Merged and optimized from 3 legacy API documentation skills.

Security

  • Security scanPassed, 95 of 100Pattern checks on the skill's files.
  • Model reviewPassed

Quality evaluation

  • Task evaluationNot runNo evaluation yet. Run one in Skill Studio.

Source

Popularity

7-day trend score
5

Not refreshed yet.

Works with

Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.

  • Claude Code
  • Cursor
  • GitHub Copilot
  • Windsurf
  • Codex
  • Gemini CLI
  • Cline
  • Amp
  • Roo Code
  • Goose
  • Continue
  • Kilo Code
  • Junie
  • Trae
  • OpenHands
  • Qwen Code
  • AI Agent
  • Tabnine Chat
  • Sourcegraph Cody
  • Amazon Q
  • Firebase Genkit
  • Sweep
  • Devin
  • Phind
  • Mentat
  • Claude Desktop
  • Aider
  • GPT Pilot
  • Plandex
  • bolt.new
  • v0
  • Replit Agent
  • Anse
  • TypingMind
  • BetterChatGPT
  • LibreChat
  • Warp AI
  • Pieces
  • Fig AI
Embed badge
vskill VERIFIED badge
[![vskill VERIFIED](https://verified-skill.com/api/v1/skills/bnloading/newshaqyrus/api-documenter/badge)](https://verified-skill.com/skills/bnloading/newshaqyrus/api-documenter)

Something wrong with this skill or its page? Tell us.