apidoc

Generate Markdown and OpenAPI documentation from source code and route definitions.

Updated Feb 7, 2026
One-click install
npx skills add https://github.com/maggit/claude-workspace --skill apidoc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: apidoc
Source: https://github.com/maggit/claude-workspace/tree/main/skills/apidoc
Command: npx skills add https://github.com/maggit/claude-workspace --skill apidoc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate API documentation from code automatically to save manual effort and keep docs synced with source.

Core Features & Use Cases

  • Discover endpoints and extract method, path, parameters, request/response structures across frameworks.
  • Generate Markdown docs and OpenAPI/Swagger specs for publishing to docs sites, Postman collections, or internal docs.
  • Use case: when starting a new API, generate docs from code to accelerate onboarding for developers and clients.

Quick Start

Ask me to generate API docs from your codebase and specify the desired output format (Markdown, OpenAPI, or both).

Frequently Asked Questions about apidoc

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

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

Generate API documentation from source code automatically by extracting endpoints, parameters, request bodies, and auth details directly from route definitions. The extracted data is then formatted into Markdown and OpenAPI outputs for consistent, up-to-date docs.

Can I extract OpenAPI specs from existing Node.js, Python, Go, or Java projects?

Yes, you can extract OpenAPI specs from existing Node.js, Python, Go, and Java projects. The tool discovers RESTful services across these stacks and formats route definitions into OpenAPI/Swagger specs for publishing.

What is the best way to keep my Markdown API docs synced with my codebase?

The best way to keep Markdown API docs synced with your codebase is to automate extraction directly from source code route definitions. This ensures documentation stays consistent and up-to-date whenever endpoints or parameters change.

Does this API documentation generator work with RESTful services across different stacks?

Yes, this API documentation generator works with RESTful services across different stacks including Node.js, Python, Go, and Java. It extracts method, path, and response structures consistently regardless of the underlying framework.

How do I create Markdown docs and Swagger specs from my route definitions?

Create Markdown docs and Swagger specs from route definitions by specifying your desired output format. The automation extracts endpoints, parameters, and responses to generate both formats for publishing to documentation sites or Postman collections.