api-documentation-generator

Name: api-documentation-generator
Availability: InStock
Author: chirag-cs

Parse source code to generate OpenAPI specs and Markdown API documentation.

Updated Apr 24, 2026

Search Tags:#documentation #markdown #api #openapi #codebase #endpoints #generate

Ready to run

npx skills add https://github.com/chirag-cs/claude-howto --skill api-documentation-generator-chirag-cs

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-documentation-generator
Source: https://github.com/chirag-cs/claude-howto/tree/main/zh/03-skills/doc-generator
Command: npx skills add https://github.com/chirag-cs/claude-howto --skill api-documentation-generator-chirag-cs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

从源代码生成全面且准确的 API 文档，帮助团队创建或更新 API 文档、生成 OpenAPI 规范，并在用户提到 API 文档、端点或说明时提供参考。

Core Features & Use Cases

生成 OpenAPI / Swagger 规范
创建端点参考文档、SDK 使用示例
生成集成指南与错误码参考

Quick Start

在给定代码库上运行此技能，即可快速生成所有服务的 API 文档。

Frequently Asked Questions about api-documentation-generator

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

FAQPage Schema

How do I generate API documentation from source code?▼

OpenAPI specs and Markdown documentation are generated by parsing source code to extract endpoints, parameters, and responses, producing comprehensive API references with usage examples for developers.

Can I automatically create OpenAPI specifications from an existing codebase?▼

Yes, this Skill parses your existing codebase to automatically generate OpenAPI and Swagger specifications, extracting endpoints and parameters to create comprehensive API surfaces across multiple languages.

Does this API documentation generator support Markdown output for endpoint references?▼

Yes, the Skill outputs Markdown documentation including endpoint references, SDK usage examples, integration guides, and error code references alongside generated OpenAPI specifications.

What is the best way to create endpoint references and integration guides across multiple programming languages?▼

The best way is to use a parsing Skill that extracts API surfaces across multiple languages and codebases, generating standardized endpoint references and integration guides automatically from the source code.

Do I need any specific dependencies or components to generate API docs from my codebase?▼

No specific dependencies or components are required, as this standalone Skill parses source code directly to produce OpenAPI specs and Markdown documentation without needing external modules or libraries.

Why generate API documentation directly from source code instead of writing it manually?▼

Generating API documentation directly from source code ensures accuracy by automatically parsing endpoints, parameters, and responses, keeping OpenAPI specs and Markdown references synchronized with the actual codebase.