api-doc-generator

Community

Auto-generate API documentation.

AuthorGreenmamba29
Version1.0.0
Installs0

System Documentation

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.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: api-doc-generator
Download link: https://github.com/Greenmamba29/skillsdotmd_web/archive/main.zip#api-doc-generator

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.