api-document-generator

Community

Generate OpenAPI docs from code with timestamps.

Authorchaorenex1
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This skill automates API documentation by parsing code interfaces, generates OpenAPI-compliant specs, and publishes Markdown documentation with timestamped metadata.

Core Features & Use Cases

  • File Parsing: Extract API interfaces from code files or directories.
  • OpenAPI Compliance: Generate standards-compliant API documentation.
  • Timestamp Management: Include generation timestamps in docs.
  • Directory Scanning: Process multiple files within a project.
  • Validation: Validate OpenAPI output for correctness.

Quick Start

Generate documentation from a directory of API files or a single file and review the resulting Markdown docs.

Dependency Matrix

Required Modules

pyyaml

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: api-document-generator
Download link: https://github.com/chaorenex1/coding-agent-workflow/archive/main.zip#api-document-generator

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.