Generate Markdown API documentation from Rails routes and controllers.
npx skills add https://github.com/erwaen/one-shot-test --skill gen-api-docs
Please help me install this Agent Skill. Skill: gen-api-docs Source: https://github.com/erwaen/one-shot-test/tree/main/.claude/skills/gen-api-docs Command: npx skills add https://github.com/erwaen/one-shot-test --skill gen-api-docs
Generate API documentation from existing routes and controllers to provide an up-to-date reference for developers and integrators.
Run the gen-api-docs skill after building your API to generate docs/API.md.
High-intent search queries and answers about installing and using this skill.
Markdown API docs are auto-generated by extracting live Rails routes and inspecting API controllers and serializers. This skill scopes to versioned namespaces like /api/v1 and writes a structured docs/API.md file with endpoints and examples.
Generating API documentation from Rails serializers includes the HTTP method, path, required role, query params, request and response examples, and common error cases. It inspects app/controllers/api/v1/ and app/serializers/ to derive these response shapes.
Yes, you can generate API reference docs for specific versioned namespaces like /api/v1 in Rails. The skill scopes exclusively to these API versioned namespaces to enumerate all endpoints and derive request and response shapes from the corresponding controllers.
The best way to document Rails API endpoints for external clients is to auto-extract them from live routes and serializers. This ensures your API documentation stays up-to-date by reading actual controller logic and outputting a comprehensive Markdown file.
Yes, you need Rails environment access to extract API routes and generate Markdown documentation. The skill requires direct access to your Rails environment to read routes, inspect controllers, and parse serializers to derive accurate request and response shapes.
samrocks03Generate JSON:API serializers for Rails apps using JSONAPI::Serializer conventions.
dinoudonGenerates API references and SDK scaffolds from OpenAPI specifications.
JackSmack1971Design REST API endpoints with layered Routes, Middleware, Controllers, Services, Repositories, and DTOs.
thktGenerate Markdown API specs and OpenAPI/Swagger files from codebase analysis.
