Does it validate the output against official standards?

Yes, the skill includes a validation step to ensure that the generated documentation complies with the official OpenAPI specification.

Does it support scanning entire project directories?

Absolutely. You can provide a directory path, and the skill will perform a recursive scan of all supported files to build a comprehensive API map.

Which programming languages does this skill support?

The API Documentation Generator supports Python (.py), JavaScript (.js), TypeScript (.ts), as well as JSON and YAML configuration files.

Can I include example requests and responses in the docs?

Yes, by using the optional 'include_examples' parameter, the skill will automatically attempt to generate sample data for your endpoints.

Where are the generated documentation files saved?

All generated documentation is saved to the 'current_repository/.claude/api_doc/' directory as timestamped Markdown files.

API Documentation Generator

Name: API Documentation Generator
Author: chaorenex1

bychaorenex1

•

API開発

Automatically generates OpenAPI-compliant documentation by parsing interface and endpoint definitions directly from your source code.

概要

The API Documentation Generator is a specialized Claude Code skill that bridges the gap between source code and technical documentation. By scanning files or entire directories, it intelligently extracts endpoint signatures, request/response schemas, and authentication requirements to build comprehensive, timestamped OpenAPI specifications. This tool is essential for developers who want to maintain accurate, up-to-date documentation without manual overhead, supporting popular languages like Python, JavaScript, and TypeScript while ensuring all output adheres to industry-standard Swagger specifications.

主な機能

1 GitHub stars
Intelligent directory scanning and interface parsing
Automated OpenAPI-compliant documentation generation
Multi-language support for Python, JavaScript, and TypeScript
Built-in validation against OpenAPI specification standards
Integrated timestamp management for version tracking

ユースケース

Generating standardized OpenAPI schemas for cross-team collaboration and client handoff
Maintaining real-time technical documentation during rapid development sprints
Converting legacy codebases into well-documented API endpoints automatically

概要

主な機能

1 GitHub stars
Intelligent directory scanning and interface parsing
Automated OpenAPI-compliant documentation generation
Multi-language support for Python, JavaScript, and TypeScript
Built-in validation against OpenAPI specification standards
Integrated timestamp management for version tracking

ユースケース

Generating standardized OpenAPI schemas for cross-team collaboration and client handoff
Maintaining real-time technical documentation during rapid development sprints
Converting legacy codebases into well-documented API endpoints automatically