api-documentation-generator

Generate OpenAPI-compatible API documentation from codebases.

1|Updated Mar 26, 2026
One-click install
npx skills add https://github.com/caobingsheng/skills --skill api-documentation-generator-caobingsheng
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-documentation-generator
Source: https://github.com/caobingsheng/skills/tree/main/api/api-documentation-generator
Command: npx skills add https://github.com/caobingsheng/skills --skill api-documentation-generator-caobingsheng

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically creates clear, comprehensive API documentation directly from codebases, reducing manual writing and drift between implementation and docs.

Core Features & Use Cases

  • Automatic endpoint discovery and description for REST, GraphQL, and WebSocket APIs.
  • Support for request/response examples, authentication details, error handling, and best practices.
  • OpenAPI/Swagger compatibility and ready-to-publish docs for teams and external users.

Quick Start

Point the tool at your codebase and generate OpenAPI-compatible documentation in minutes.

Frequently Asked Questions about api-documentation-generator

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

FAQPage Schema
How do I generate API documentation directly from code?

You can generate API documentation directly from code by pointing the tool at your codebase to automatically discover endpoints, usage examples, and authentication details. It analyzes your code to produce ready-to-publish docs, reducing manual writing and drift.

What is the best way to create OpenAPI-compatible docs from an existing codebase?

The best way to create OpenAPI-compatible docs from an existing codebase is by using a generator that automatically identifies and documents all API endpoints from the source code. This ensures conformance to OpenAPI-like structures while including examples, errors, and authentication details.

Does the API documentation generator support GraphQL and WebSocket APIs?

Yes, the API documentation generator supports GraphQL and WebSocket APIs. It automatically identifies and documents endpoints across multiple languages and frameworks, applying to REST, GraphQL, and WebSocket APIs to create comprehensive, developer-friendly documentation.

Can I include error handling and authentication details in my generated API docs?

Yes, you can include error handling and authentication details in your generated API docs. The tool supports request and response examples, authentication details, and error handling to ensure comprehensive documentation for teams and external users.

Why should I automate endpoint discovery instead of writing API docs manually?

Automating endpoint discovery eliminates manual writing and prevents drift between implementation and documentation. By identifying and documenting all API endpoints and their usage directly from code, it ensures your developer-friendly docs remain accurate and ready to publish.