api-documentation

Generate API documentation for REST and GraphQL endpoints in Markdown or OpenAPI formats.

Updated Nov 7, 2025

Search Tags:#documentation #markdown #SDK #OpenAPI #endpoints #api-documentation

Ready to run

npx skills add https://github.com/Wesley1600/ClaudeCodeFrameWork --skill api-documentation-wesley1600

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-documentation
Source: https://github.com/Wesley1600/ClaudeCodeFrameWork/tree/main/skills/api-documentation
Command: npx skills add https://github.com/Wesley1600/ClaudeCodeFrameWork --skill api-documentation-wesley1600

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps generate professional API documentation that clearly describes endpoints, parameters, responses, errors, and authentication, making APIs easy to use for developers and stakeholders.

Core Features & Use Cases

Document REST/GraphQL endpoints with descriptions, parameters, and responses
Generate OpenAPI/Swagger specifications and developer-friendly markdown
Include code samples and error references for multiple languages

Quick Start

Provide endpoint details and examples; the skill will generate structured API documentation.

Frequently Asked Questions about api-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I generate API documentation from OpenAPI specifications?▼

OpenAPI/Swagger specifications can be converted into comprehensive API documentation by extracting endpoint definitions, parameter schemas, and response models, then rendering them as structured markdown or HTML with organized sections for methods, parameters, authentication, and error codes.

Can I create documentation for both REST and GraphQL APIs?▼

Yes, this Skill supports documenting REST endpoints with HTTP methods and parameters, as well as GraphQL APIs with query and mutation definitions, enabling consistent documentation across different API architecture styles.

What should I include in API documentation to help developers?▼

Effective API documentation includes endpoint descriptions, HTTP methods, required and optional parameters, request/response schemas, authentication requirements, rate limits, error codes with explanations, and runnable code samples in multiple languages.

How do I document SDK packages and internal webhooks?▼

SDK documentation and webhook specifications are documented by describing available methods, callback events, parameter types, constraints, authentication flows, and providing implementation examples, ensuring developers understand both public and internal integrations.

What formats can API documentation be exported to?▼

Generated API documentation can be output in Markdown for GitHub/wikis, HTML for web portals, or OpenAPI/Swagger format for machine-readable specifications and interactive API explorers.

Why is versioning and consistency important in API documentation?▼

Automated documentation ensures consistency across all endpoints, prevents outdated information, maintains alignment between specifications and actual implementations, and simplifies updates when API versions or endpoints change.