api-docs

Generate OpenAPI 3.0 specifications by discovering REST API endpoints.

1|Updated Jan 5, 2026
One-click install
npx skills add https://github.com/Rene-Kuhm/opencode-ohmyopencode-claude-configuracion --skill api-docs-rene-kuhm
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-docs
Source: https://github.com/Rene-Kuhm/opencode-ohmyopencode-claude-configuracion/tree/main/skills/api-docs
Command: npx skills add https://github.com/Rene-Kuhm/opencode-ohmyopencode-claude-configuracion --skill api-docs-rene-kuhm

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The API documentation workflow often requires manually summarizing endpoints and generating OpenAPI specs. This Skill automates endpoint discovery and OpenAPI 3.0 generation, reducing manual effort and ensuring consistency.

Core Features & Use Cases

  • Auto-discovery of endpoints across frameworks (Next.js app router, Next.js pages/api, Express/Fastify, tRPC) and extraction of methods, paths, parameters, request bodies, responses, and security requirements.
  • OpenAPI 3.0 compliant generation with templates and optional integration with Zod schemas for schema extraction.
  • Interactive documentation export (Swagger UI and Redoc) and support for openapi.yaml/json outputs for CI/CD validation.

Quick Start

Generate an OpenAPI 3.0 specification for your REST API by scanning your codebase and exporting openapi.yaml

Frequently Asked Questions about api-docs

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

FAQPage Schema
How do I generate OpenAPI specifications from an existing Express or Next.js codebase?

This approach auto-discovers endpoints across frameworks like Next.js, Express, and tRPC, extracting methods, paths, and security requirements to translate them directly into OpenAPI 3.0 artifacts without manual summarization.

Does OpenAPI generation work with tRPC and Zod schemas?

Yes, OpenAPI generation works with tRPC and supports optional integration with Zod schemas, allowing you to automatically extract and translate schema definitions into your OpenAPI 3.0 specification documentation.

Can I export interactive API documentation like Swagger UI and Redoc from my codebase?

Yes, you can export interactive API documentation like Swagger UI and Redoc from your codebase, providing visual and navigable interfaces alongside your standard openapi.yaml or openapi.json output files.

How do I automate endpoint discovery for REST APIs across multiple frameworks?

Automate endpoint discovery for REST APIs by scanning your codebase to identify routes across Next.js app router, pages/api, Express, Fastify, and tRPC, automatically extracting paths, request bodies, and security requirements.

What is the best way to validate OpenAPI 3.0 specs in a CI/CD pipeline?

The best way to validate OpenAPI 3.0 specs in CI/CD is to automatically generate openapi.yaml or openapi.json files from your codebase, ensuring the exported specifications remain compliant and synchronized with your code changes.

Do I need to manually define security schemes when generating OpenAPI docs?

No, you do not need to manually define security schemes; the generation process automatically discovers and satisfies OpenAPI templates, servers, and security requirements extracted directly from your REST API codebase.