api-doc-generator

Generate API documentation from source code, OpenAPI specs, or Postman collections.

Updated Feb 18, 2026
One-click install
npx skills add https://github.com/Greenmamba29/skillsdotmd_web --skill api-doc-generator-greenmamba29
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-doc-generator
Source: https://github.com/Greenmamba29/skillsdotmd_web/tree/main/.agents/skills/api-doc-generator
Command: npx skills add https://github.com/Greenmamba29/skillsdotmd_web --skill api-doc-generator-greenmamba29

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation and updating of comprehensive API documentation, ensuring that developers and users have accurate and up-to-date information about API endpoints, parameters, and usage.

Core Features & Use Cases

  • Automated Documentation Generation: Creates human-readable documentation from code, OpenAPI specs, or Postman collections.
  • Endpoint Extraction: Identifies and details all API endpoints, including parameters and schemas.
  • Usage Examples: Generates practical code snippets for common languages like curl, JavaScript, and Python.
  • Use Case: Automatically generate and maintain documentation for a new microservice built with FastAPI, ensuring all 50+ endpoints are clearly described with usage examples.

Quick Start

Use the api-doc-generator skill to generate Markdown documentation for the provided FastAPI source code.

Frequently Asked Questions about api-doc-generator

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

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

To auto-generate API documentation, you can use this skill to extract endpoints, parameters, and schemas directly from your source code to create human-readable descriptions and usage examples.

Can I generate API docs from an OpenAPI specification or Postman collection?

Yes, you can generate API docs from an OpenAPI specification or Postman collection. The tool extracts endpoints and schemas from these sources to produce comprehensive documentation with usage examples.

How do I create usage examples in multiple languages for my API endpoints?

You can create usage examples in multiple languages by processing your OpenAPI specs or source code. The tool generates practical code snippets for common languages like curl, JavaScript, and Python.

Does the API documentation generator work with FastAPI source code?

Yes, the API documentation generator works with FastAPI source code. You can use it to generate Markdown documentation, ensuring all endpoints in your microservice are clearly described.

How do I identify undocumented endpoints in my API?

To identify undocumented endpoints in your API, this skill analyzes your source code or OpenAPI specs and flags any undocumented endpoints for improved API clarity and maintainability.

What is the best way to maintain documentation for a microservice with many endpoints?

The best way to maintain microservice documentation is to automate generation from source code or OpenAPI specs, ensuring all 50+ endpoints are clearly described with up-to-date usage examples.