api-document-generator

Parse your API interface definitions from code files or directories to extract endpoints, schemas, and metadata, then generate OpenAPI 3.0.3-compliant Markdown documentation with timestamps. The Skill processes Python, JavaScript/TypeScript, JSON, and YAML projects and validates output against OpenAPI standards.

Yes, the Skill scans directory trees and processes multiple files across your project in a single operation. It extracts API interfaces from all supported file formats and consolidates them into comprehensive documentation with authentication details, example requests and responses, and error codes.

The Skill supports Python, JavaScript/TypeScript, JSON, and YAML projects. It parses API and interface definitions from these formats and generates standards-compliant OpenAPI documentation with configurable output locations and optional JSON artifacts.

The Skill validates generated output against OpenAPI 3.0.3 standards automatically. It includes validation checks in its core processing to ensure your Markdown and optional JSON documentation comply with OpenAPI specifications before output.

Yes, the Skill embeds generation timestamps and metadata in your API documentation by default. This provides traceability and version control information within your Markdown output alongside the API specifications.

The Skill requires PyYAML as its only dependency, which enables parsing YAML-formatted API definitions and OpenAPI specifications from your code files and configuration.