api-doc-generator

Generate REST and GraphQL API docs as Markdown, OpenAPI YAML, or Blueprint from source code.

615|100|Updated Jan 28, 2026
One-click install
npx skills add https://github.com/JackyST0/awesome-agent-skills --skill api-doc-generator-jackyst0
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-doc-generator
Source: https://github.com/JackyST0/awesome-agent-skills/tree/main/examples/api-doc-generator
Command: npx skills add https://github.com/JackyST0/awesome-agent-skills --skill api-doc-generator-jackyst0

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Convert codebases into clear API documentation by automatically extracting endpoints, methods, parameters, and data models for REST and GraphQL, saving time and reducing errors.

Core Features & Use Cases

  • Analyze API type (REST, GraphQL, RPC) and determine endpoints and methods.
  • Extract endpoint information including paths, parameters, request/response formats, and authentication requirements.
  • Generate documentation in Markdown, OpenAPI 3.0 YAML, or API Blueprint, suitable for developer portals and team documentation.
  • Use case: when onboarding developers to a new codebase, or updating docs after API changes, with single-source truth from source code.

Quick Start

Use the skill to generate documentation from your codebase with a single command

Frequently Asked Questions about api-doc-generator

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

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

To generate API documentation from source code automatically, use a tool that analyzes your codebase to identify endpoints, parameters, and responses, then outputs standards-compliant Markdown, OpenAPI YAML, or API Blueprint files.

Can I extract REST and GraphQL endpoints into OpenAPI YAML?

Yes, you can extract REST and GraphQL endpoints into OpenAPI YAML by analyzing the source code to identify API types, paths, methods, and authentication details, then generating a standards-compliant OpenAPI 3.0 YAML output.

What is the best way to update API docs after code changes?

The best way to update API docs after code changes is to automate generation from the source code, ensuring the documentation accurately reflects new endpoints, parameters, and request formats without manual updates.

Does API documentation generation work for both REST and GraphQL?

Yes, API documentation generation works for both REST and GraphQL by automatically analyzing the codebase to determine the API type, extract endpoints, and identify data models for standards-compliant output formats.

What output formats can I generate for my API docs?

You can generate API docs in Markdown, OpenAPI 3.0 YAML, or API Blueprint formats, making them suitable for developer portals and internal team documentation extracted directly from your source code.