API Documentation Generator

dokhacgiakhoa/api-documentation-generator

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

3k tokens

context cost

the whole folder, loaded on every use

files

instructions only

copies elsewhere

how many repositories repackaged it

505

stars on the repo

on the repository, not the skill itself

Install

one command, takes just this skill from the repository

npx skills add https://github.com/Dokhacgiakhoa/Agent-Skills-4-Vibe-Coding-CLI --skill api-documentation-generator

What comes with it

10 224 bytes besides the instruction

sub-skills/do-this.md

sub-skills/dont-do-this.md

sub-skills/example-1-rest-api-endpoint-documentation.md

sub-skills/example-2-graphql-api-documentation.md

sub-skills/example-3-authentication-documentation.md

sub-skills/getting-a-token.md

sub-skills/openapiswagger.md

sub-skills/postman-collection.md

sub-skills/problem-documentation-gets-out-of-sync.md

sub-skills/problem-examples-dont-work.md

sub-skills/problem-missing-error-documentation.md

sub-skills/problem-unclear-parameter-requirements.md

sub-skills/recommended-sections.md

sub-skills/step-1-analyze-the-api-structure.md

sub-skills/step-2-generate-endpoint-documentation.md

sub-skills/step-3-add-usage-guidelines.md

sub-skills/step-4-document-error-handling.md

sub-skills/step-5-create-interactive-examples.md

sub-skills/token-expiration.md

sub-skills/using-the-token.md

The instruction itself

25 sections, as written by the author

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

How to use it

Copy the folder

Take dokhacgiakhoa/api-documentation-generator from the repository into ~/.claude/skills for personal use, or into .claude/skills inside a project.

Check the name does not clash

The agent identifies a skill by the name field in its header. Two skills with the same name cannot sit side by side — one of them will be ignored.