skills.rest
haotool
haotoolOFFICIAL
Explore all skills by this author →
GitHub

api-documentation-generator

Generate endpoint descriptions, parameter schemas, and OpenAPI specs from source code.

2|Updated Oct 12, 2025
Search Tags:#documentation#api#openapi#swagger#postman#code-generation
One-click install
npx skills add https://github.com/haotool/app --skill api-documentation-generator-haotool
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-documentation-generator
Source: https://github.com/haotool/app/tree/main/.agents/skills/api-documentation-generator
Command: npx skills add https://github.com/haotool/app --skill api-documentation-generator-haotool

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically generate clear, developer-friendly API documentation from source code, including endpoints, parameters, examples, and best practices.

Core Features & Use Cases

  • Automatically generate endpoint descriptions, parameter schemas, request/response examples, and authentication details from source code.
  • Support REST, GraphQL, and WebSocket APIs; produce OpenAPI/Swagger specs and Postman collections.
  • Use cases include documenting a new API, updating existing docs after code changes, and onboarding new engineers quickly.

Quick Start

Run the tool against your codebase to generate a ready OpenAPI specification and example documentation.

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 OpenAPI specifications from source code automatically?▼

To generate OpenAPI specifications from source code, run this tool against your codebase to parse endpoints and parameter schemas, producing a ready OpenAPI spec and example documentation.

What is the best way to document REST, GraphQL, and WebSocket APIs for developer onboarding?▼

Documenting REST, GraphQL, and WebSocket APIs for developer onboarding involves generating endpoint descriptions, request/response examples, and authentication notes directly from your existing source code.

Can I create Postman collections from existing code instead of writing them manually?▼

Yes, you can create Postman collections from existing code by running this generator against your codebase, which automatically extracts endpoints and schemas to produce the collection files.

Does this approach work for updating existing API documentation after code changes?▼

Updating existing API documentation after code changes is fully supported by rerunning the generator against your modified codebase to refresh endpoint descriptions and parameter schemas.

What specific API documentation elements are extracted from the codebase?▼

The API documentation elements extracted from the codebase include endpoint descriptions, parameter schemas, request/response examples, authentication notes, and error handling guidance.

Related Skills

Explore More Software Engineering Skills→
chaorenex1chaorenex1
3

api-document-generator

Parse code files to generate OpenAPI 3.0.3 compliant Markdown documentation.

Community
Advanced
zhaono1zhaono1
69

api-documenter

Generate OpenAPI 3.0/3.x specifications and endpoint documentation from REST APIs.

Community
Intermediate
IndustrialIndustrial

api-documentation-generator

Generate API documentation with endpoints, schemas, and OpenAPI specifications.

Community
Intermediate
OneWave-AIOneWave-AI
245

api-documentation-writer

Generate OpenAPI/Swagger specs and endpoint documentation for REST, GraphQL, WebSocket, and gRPC APIs.

Official
Basic