api-documentor

Community

Auto-generate API docs and SDKs, stay in sync.

Authorbenreceveur
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill eliminates the manual, error-prone, and time-consuming process of creating and maintaining API documentation and client SDKs. It ensures your API specifications and client libraries are always synchronized with your codebase, reducing developer friction and improving API adoption.

Core Features & Use Cases

  • Automated Spec Generation: Generates OpenAPI/Swagger specifications from REST API code and GraphQL schemas from resolvers.
  • Client SDK Generation: Automatically creates client SDKs in multiple languages (Python, JavaScript/TypeScript, Go, Java) from your API specification.
  • Human-Readable Documentation: Produces comprehensive API reference documentation in formats like HTML or Markdown for easy consumption.
  • Use Case: After developing a new API endpoint, use this Skill to automatically update your OpenAPI specification, regenerate the Python and TypeScript client SDKs, and publish the latest HTML documentation to your developer portal, all with a single command.

Quick Start

Generate an OpenAPI specification from the Flask application file 'app.py'.

Dependency Matrix

Required Modules

python3pyyaml

Components

scriptsexamples

💻 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-documentor
Download link: https://github.com/benreceveur/claude-workflow-engine/archive/main.zip#api-documentor

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