bnloading/newshaqyrus/api-documentation-generator

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.

Generate comprehensive, developer-friendly API documentation from code, including endpoints, parameters, examples, and best practices

Install

npx vskill@latest install bnloading/newshaqyrus/api-documentation-generator

SKILL.md

The same SKILL.md was published earlier as gabrielmoreira/agent-skills-mirror/api-documentation-generator.

API Documentation Generator

Overview

Automatically generate clear, comprehensive API documentation from your codebase. This skill helps you create professional documentation that includes endpoint descriptions, request/response examples, authentication details, error handling, and usage guidelines.

Perfect for REST APIs, GraphQL APIs, and WebSocket APIs.

When to Use This Skill

  • Use when you need to document a new API
  • Use when updating existing API documentation
  • Use when your API lacks clear documentation
  • Use when onboarding new developers to your API
  • Use when preparing API documentation for external users
  • Use when creating OpenAPI/Swagger specifications

How It Works

🧠 Knowledge Modules (Fractal Skills)

1. Step 1: Analyze the API Structure
2. Step 2: Generate Endpoint Documentation
3. Step 3: Add Usage Guidelines
4. Step 4: Document Error Handling
5. Step 5: Create Interactive Examples
6. Example 1: REST API Endpoint Documentation
7. Example 2: GraphQL API Documentation
8. Example 3: Authentication Documentation
9. Getting a Token
10. Using the Token
11. Token Expiration
12. ✅ Do This
13. ❌ Don't Do This
14. Recommended Sections
15. Problem: Documentation Gets Out of Sync
16. Problem: Missing Error Documentation
17. Problem: Examples Don't Work
18. Problem: Unclear Parameter Requirements
19. OpenAPI/Swagger
20. Postman Collection

Security

  • Security scanPassed, 90 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-documentation-generator/badge)](https://verified-skill.com/skills/bnloading/newshaqyrus/api-documentation-generator)

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