api-documentation-generator

Generate OpenAPI 3.0 and Markdown documentation from code routes.

1|Updated Sep 26, 2025
One-click install
npx skills add https://github.com/pascallammers/mylo-travel-concierge-v2 --skill api-documentation-generator-pascallammers
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-documentation-generator
Source: https://github.com/pascallammers/mylo-travel-concierge-v2/tree/main/.factory/skills/api-documentation-generator
Command: npx skills add https://github.com/pascallammers/mylo-travel-concierge-v2 --skill api-documentation-generator-pascallammers

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of professional API documentation, including OpenAPI/Swagger specifications and Markdown references, directly from your codebase.

Core Features & Use Cases

  • Automated Spec Generation: Creates OpenAPI 3.0 compliant YAML files.
  • Markdown Reference Creation: Generates human-readable API documentation.
  • Code Scanning: Detects API patterns in popular frameworks like Express.js, Next.js, and FastAPI.
  • Example Generation: Includes working cURL, JavaScript, and Python examples for endpoints.
  • Use Case: When you've just finished building a new set of API endpoints, use this Skill to instantly generate the necessary documentation for your team and consumers.

Quick Start

Use the api-documentation-generator skill to create an OpenAPI spec for the current API project.

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 existing code?

Generate OpenAPI specifications by scanning your codebase for route definitions, controllers, and validation schemas. This Skill extracts methods, paths, parameters, and responses to produce compliant OpenAPI 3.0 YAML files automatically.

Can I create Markdown API reference documentation directly from my source code?

Create Markdown API reference documentation directly from source code. The Skill scans your project to extract endpoint metadata and generates human-readable Markdown references alongside the OpenAPI specifications.

Does API documentation generation work with Express.js, Next.js, and FastAPI frameworks?

API documentation generation works with Express.js, Next.js, and FastAPI frameworks. The Skill detects API patterns and route definitions within these frameworks to accurately extract metadata for your documentation.

How do I generate cURL and Python code examples for my API endpoints?

Generate cURL, JavaScript, and Python code examples by scanning your API route definitions. The Skill extracts endpoint metadata and automatically produces working code examples for consumers of your API.

What is the best way to automate Swagger spec creation after building new API endpoints?

Automate Swagger spec creation after building endpoints by running this Skill against your codebase. It detects validation schemas and route definitions to output accurate OpenAPI 3.0 specifications without manual entry.