API Documentation Generator

Generate API documentation from source code into Markdown, OpenAPI 3.0, and Postman Collections.

1|Updated Feb 3, 2026
One-click install
npx skills add https://github.com/run6270/skill --skill api-documentation-generator-run6270
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: API Documentation Generator
Source: https://github.com/run6270/skill/tree/main/api-doc-generator
Command: npx skills add https://github.com/run6270/skill --skill api-documentation-generator-run6270

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the creation of comprehensive API documentation, saving developers time and ensuring consistency.

Core Features & Use Cases

  • Endpoint Documentation: Details HTTP methods, paths, parameters, request/response bodies, and status codes.
  • Authentication Details: Covers authentication methods and requirements.
  • Example Generation: Provides sample requests and responses.
  • Schema Definition: Documents data models and structures.
  • Output Formats: Supports Markdown, OpenAPI 3.0, and Postman Collections.
  • Use Case: Automatically generate an OpenAPI 3.0 specification for a new REST API to share with frontend developers and API consumers.

Quick Start

Use the API Documentation Generator skill to create OpenAPI 3.0 documentation for the codebase.

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 3.0 documentation from source code?

You can generate OpenAPI 3.0 documentation by extracting endpoint details, authentication methods, and request/response schemas directly from your source code. This skill automates the extraction process to produce valid OpenAPI 3.0 specifications for API consumers.

What output formats can I create when generating API documentation?

You can create Markdown, OpenAPI 3.0, and Postman Collections when generating API documentation. These formats allow you to easily share endpoint details, example requests, and response schemas with frontend developers and API consumers.

Can I generate Postman Collections from an existing REST API codebase?

Yes, you can generate Postman Collections from an existing REST API codebase. The process involves scanning your source code to extract HTTP methods, paths, parameters, and example responses to build a ready-to-use collection for testing.

Does API documentation generation include authentication details and schema definitions?

Yes, API documentation generation includes authentication details and schema definitions. It automatically documents your data models, structures, and authentication requirements alongside endpoint paths and status codes for comprehensive API coverage.

What is the best way to automate API documentation for frontend developers?

The best way to automate API documentation for frontend developers is to use a tool that extracts endpoint details and example generation directly from your source code. This ensures consistency and provides frontend teams with accurate OpenAPI 3.0 or Markdown specifications.