api-documentor

Generates OpenAPI specs, GraphQL schemas, and client SDKs from code.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/benreceveur/claude-workflow-engine --skill api-documentor
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-documentor
Source: https://github.com/benreceveur/claude-workflow-engine/tree/main/skills/api-documentor
Command: npx skills add https://github.com/benreceveur/claude-workflow-engine --skill api-documentor

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires python3, pyyaml, and includes scripts (resource) and examples (resource) components.

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'.

Frequently Asked Questions about api-documentor

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

FAQPage Schema
How do I automatically generate API documentation from my code?

Automated API documentation generation extracts endpoint details, schemas, and authentication from your codebase to produce OpenAPI/Swagger specifications and human-readable docs without manual writing. This Skill analyzes REST API and GraphQL code to generate OpenAPI 3.0 specs, GraphQL documentation, and HTML or Markdown reference guides in a single command.

Can I generate client SDKs in multiple languages from an OpenAPI spec?

Yes. This Skill generates multi-language client SDKs—Python, JavaScript/TypeScript, Go, and Java—directly from your OpenAPI specification or GraphQL schema, eliminating manual SDK maintenance and keeping all clients synchronized with your API implementation.

How do I keep my API documentation in sync with code changes?

Regenerating documentation from your codebase ensures specs and SDKs reflect current implementation automatically. Run this Skill after API updates to produce fresh OpenAPI specs, GraphQL schemas, and client libraries without manual reconciliation, preventing documentation drift.

Does this work with both REST APIs and GraphQL services?

Yes. This Skill handles both REST APIs—generating OpenAPI/Swagger specifications and client SDKs—and GraphQL services by extracting schema definitions from resolvers and producing GraphQL documentation alongside multi-language client libraries.

What do I need before generating API documentation?

You need Python 3, PyYAML for processing, and your API source code (Flask, Express, GraphQL resolvers, etc.). The Skill analyzes your code structure to extract endpoints, request/response schemas, authentication details, and error definitions for spec generation.

Can I customize the generated documentation format?

This Skill produces OpenAPI 3.0 specifications and outputs documentation in formats like HTML and Markdown. You can then transform or customize these standard formats using additional tools in your documentation pipeline or developer portal.