Skills
.Work. You
Rest

gen-api-docs

Community

Auto-generate Markdown API docs from Rails routes.

Software Engineering#documentation#markdown#api#rails#routes#serialization
Authorerwaen
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Generate API documentation from existing routes and controllers to provide an up-to-date reference for developers and integrators.

Core Features & Use Cases

  • Live-route extraction: reads Rails routes to enumerate all API endpoints under /api/v1.
  • Controller & serializer awareness: inspects app/controllers/api/v1/ and app/serializers/ to derive request/response shapes.
  • Markdown output: writes a structured docs/API.md with endpoints, params, examples, and common error cases.
  • Use case: After API development, quickly generate docs for onboarding and external clients.

Quick Start

Run the gen-api-docs skill after building your API to generate docs/API.md.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 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: gen-api-docs
Download link: https://github.com/erwaen/one-shot-test/archive/main.zip#gen-api-docs

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 471,000+ vetted skills library on demand.