How do I install the API Documentation Generator skill?

Run npx skillmds@latest add dokhacgiakhoa/api-documentation-generator 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 Documentation Generator safe to use?

This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. Capability flags: makes network calls, reads secrets. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with API Documentation Generator?

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 Documentation Generator free to use?

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

Who published API Documentation Generator?

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

API Documentation Generator by dokhacgiakhoa

Name: API Documentation Generator
Rating: 4.666666666666667 (3 reviews)
Author: Dokhacgiakhoa

File contents

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

---name: api-documentation-generatordescription: Generate comprehensive, developer-friendly API documentation from code, including endpoints, parameters, examples, and best practices--- # 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](./sub-skills/step-1-analyze-the-api-structure.md) ### 2. [Step 2: Generate Endpoint Documentation](./sub-skills/step-2-generate-endpoint-documentation.md) ### 3. [Step 3: Add Usage Guidelines](./sub-skills/step-3-add-usage-guidelines.md) ### 4. [Step 4: Document Error Handling](./sub-skills/step-4-document-error-handling.md) ### 5. [Step 5: Create Interactive Examples](./sub-skills/step-5-create-interactive-examples.md) ### 6. [Example 1: REST API Endpoint Documentation](./sub-skills/example-1-rest-api-endpoint-documentation.md) ### 7. [Example 2: GraphQL API Documentation](./sub-skills/example-2-graphql-api-documentation.md) ### 8. [Example 3: Authentication Documentation](./sub-skills/example-3-authentication-documentation.md) ### 9. [Getting a Token](./sub-skills/getting-a-token.md) ### 10. [Using the Token](./sub-skills/using-the-token.md) ### 11. [Token Expiration](./sub-skills/token-expiration.md) ### 12. [✅ Do This](./sub-skills/do-this.md) ### 13. [❌ Don't Do This](./sub-skills/dont-do-this.md) ### 14. [Recommended Sections](./sub-skills/recommended-sections.md) ### 15. [Problem: Documentation Gets Out of Sync](./sub-skills/problem-documentation-gets-out-of-sync.md) ### 16. [Problem: Missing Error Documentation](./sub-skills/problem-missing-error-documentation.md) ### 17. [Problem: Examples Don't Work](./sub-skills/problem-examples-dont-work.md) ### 18. [Problem: Unclear Parameter Requirements](./sub-skills/problem-unclear-parameter-requirements.md) ### 19. [OpenAPI/Swagger](./sub-skills/openapiswagger.md) ### 20. [Postman Collection](./sub-skills/postman-collection.md)

Frequently asked questions

API Documentation Generator

File contents

API Documentation Generator

Overview

When to Use This Skill

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

Related skills

Frequently asked questions

How do I install the API Documentation Generator skill?

What does the API Documentation Generator skill do?

Is API Documentation Generator safe to use?

Which AI agents work with API Documentation Generator?

Is API Documentation Generator free to use?

Who published API Documentation Generator?