Communitygithub.com

Generador de Documentación API (ComeOnOliver/skillshub)

Genera documentación OpenAPI/Swagger a partir de archivos de rutas de API. Útil al trabajar con APIs REST, rutas de Express, endpoints de FastAPI o cuando el usuario solicita documentación de API.

¿Qué es skillshub)?

Esta habilidad automatiza la generación de documentación OpenAPI 3.0 (Swagger) a partir de archivos de rutas de API existentes en un repositorio. Es especialmente útil para desarrolladores que trabajan con frameworks como Express, FastAPI, Flask, NestJS, Rails o similares, y necesitan crear o actualizar especificaciones de API de manera eficiente. El proceso incluye el descubrimiento de rutas, el análisis de patrones (método HTTP, ruta, parámetros, autenticación), la generación de un archivo OpenAPI YAML/JSON, y la validación de completitud. La habilidad puede mejorar la documentación existente (por ejemplo, en FastAPI) o generarla desde cero en otros frameworks. Soporta la inclusión de ejemplos, esquemas de autenticación (Bearer, API Key, OAuth2), y la organización por etiquetas, todo ello siguiendo las mejores prácticas para la creación de documentación de APIs REST.

Compatible con~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/ComeOnOliver/skillshub/tree/HEAD/skills/aiskillstore/marketplace/crazydubya/api-documentation-generator

Preguntar en tu IA favorita

Abre un nuevo chat con esta habilidad de agente ya precargada.

Documentación

Generador de Documentación API

Esta habilidad genera automáticamente documentación OpenAPI 3.0 (Swagger) a partir de archivos de rutas de API en tu base de código.

Cuándo Usar Esta Habilidad

  • El usuario solicita generar documentación de API
  • Trabajas con endpoints de API REST
  • Necesitas crear o actualizar especificaciones OpenAPI/Swagger
  • Configurar documentación de API para Express, FastAPI, Flask, NestJS o marcos similares

Instrucciones

1. Descubrir Rutas de API

Busca en la base de código definiciones de rutas de API:

  • Express/Node.js: Busca app.get(), app.post(), router.get(), etc.
  • FastAPI/Python: Busca decoradores @app.get(), @router.post()
  • Flask: Busca decoradores @app.route()
  • NestJS: Busca decoradores @Get(), @Post(), @Controller()
  • Rails: Busca rutas en config/routes.rb

Usa Glob para encontrar archivos de rutas (ej., **/*routes*.{js,ts,py}, **/controllers/**/*.{js,ts})

2. Analizar Patrones de Rutas

Para cada ruta descubierta, extrae:

  • Método HTTP: GET, POST, PUT, PATCH, DELETE
  • Ruta: La URL del endpoint (ej., /api/users/:id)
  • Parámetros: Parámetros de ruta, parámetros de consulta, cuerpo de la solicitud
  • Respuesta: Estructura esperada de la respuesta
  • Autenticación: Si se requiere autenticación
  • Descripción: Comentarios o docstrings cerca de la ruta

3. Generar Especificación OpenAPI

Crea o actualiza un archivo de especificación OpenAPI 3.0 (normalmente openapi.yaml o swagger.json):

  • Comienza con la plantilla de templates/openapi-3.0.yaml
  • Mapea cada ruta a un objeto de ruta OpenAPI
  • Define esquemas de solicitud/respuesta usando JSON Schema
  • Incluye definiciones de parámetros (ruta, consulta, cuerpo)
  • Agrega esquemas de autenticación si se detectan (Bearer, API Key, OAuth2)
  • Agrupa endpoints por etiquetas (ej., "Usuarios", "Productos", "Autenticación")

4. Validar la Integridad

Verifica que la documentación generada incluya:

  • Todos los endpoints descubiertos
  • Métodos HTTP y rutas precisos
  • Ejemplos de solicitud/respuesta cuando sea posible
  • Respuestas de error (400, 401, 404, 500, etc.)
  • Requisitos de seguridad

5. Ubicación de Salida

  • Guarda como openapi.yaml en la raíz del proyecto, o
  • Colócalo en el directorio docs/ o api/ si existen
  • Pregunta al usuario la ubicación preferida si no está claro

Notas Específicas del Marco

Express/Node.js

  • Verifica el middleware de rutas que podría afectar la autenticación/validación
  • Busca validadores de solicitudes (Joi, express-validator, etc.)
  • Extrae comentarios JSDoc para descripciones de endpoints

FastAPI

  • FastAPI genera automáticamente documentación OpenAPI, pero esta habilidad puede mejorarla
  • Extrae modelos de Pydantic para esquemas de solicitud/respuesta
  • Verifica los parámetros response_model y status_code

NestJS

  • Busca DTOs (Objetos de Transferencia de Datos) para esquemas
  • Verifica decoradores de Swagger (@ApiOperation, @ApiResponse)
  • Extrae metadatos de decoradores de controlador y método

Mejores Prácticas

  1. Usar esquemas existentes: Si la base de código tiene interfaces de TypeScript, modelos de Pydantic o similares, úsalos para esquemas precisos
  2. Incluir ejemplos: Agrega ejemplos de solicitud/respuesta de las pruebas si están disponibles
  3. Agrupar lógicamente: Organiza los endpoints por recurso o área de funcionalidad usando etiquetas
  4. Versión adecuada: Usa la versión de API de la base de código (ej., "1.0.0")
  5. Agregar descripciones: Usa comentarios/docstrings del código para descripciones de endpoints

Archivos de Soporte

  • templates/openapi-3.0.yaml: Plantilla base de OpenAPI
  • examples.md: Ejemplos específicos del marco

Individual skills in this repo

This repo contains 20 individual skills — each has its own dedicated page.

ComeOnOliver/skillshub

Create stunning, animation-rich HTML presentations from scratch or by converting PowerPoint files. Use when the user wants to build a presentation, convert a PPT/PPTX to web, or create slides for a talk/pitch. Helps non-designers discover their aesthetic through visual exploration rather than abstract choices.

ComeOnOliver/skillshub

Next.js 16+ 和 Turbopack — 增量打包、文件系统缓存、开发速度,以及何时使用 Turbopack 与 webpack。

ComeOnOliver/skillshub

SwiftUI architecture patterns, state management with @Observable, view composition, navigation, performance optimization, and modern iOS/macOS UI best practices.

ComeOnOliver/skillshub

See, Understand, Act on video and audio. See- ingest from local files, URLs, RTSP/live feeds, or live record desktop; return realtime context and playable stream links. Understand- extract frames, build visual/semantic/temporal indexes, and search moments with timestamps and auto-clips. Act- transcode and normalize (codec, fps, resolution, aspect ratio), perform timeline edits (subtitles, text/image overlays, branding, audio overlays, dubbing, translation), generate media assets (image, audio, video), and create real time alerts for events from live streams or desktop capture.

ComeOnOliver/skillshub

AI-assisted video editing workflows for cutting, structuring, and augmenting real footage. Covers the full pipeline from raw capture through FFmpeg, Remotion, ElevenLabs, fal.ai, and final polish in Descript or CapCut. Use when the user wants to edit video, cut footage, create vlogs, or build video content.

ComeOnOliver/skillshub

Next.js 15 애플리케이션을 위한 프론트엔드 개발 가이드라인. React 19, TypeScript, Shadcn/ui, Tailwind CSS를 사용한 모던 패턴. Server Components, Client Components, App Router, 파일 구조, Shadcn/ui 컴포넌트, 성능 최적화, TypeScript 모범 사례 포함. 컴포넌트, 페이지, 기능 생성, 데이터 페칭, 스타일링, 라우팅, 프론트엔드 코드 작업 시 사용.

ComeOnOliver/skillshub

Provides Tamagui patterns for config v4, compiler optimization, styled context, and cross-platform styling. Must use when working with Tamagui projects (tamagui.config.ts, @tamagui imports).

ComeOnOliver/skillshub

Create distinctive, production-grade frontend interfaces with high design quality. Use this skill when the user asks to build web components, pages, or applications. Generates creative, polished code that avoids generic AI aesthetics.

ComeOnOliver/skillshub

Create high-converting, visually distinctive landing pages. Use when building marketing pages, product launches, SaaS homepages, or any single-page conversion-focused website. Guides section-by-section composition with anti-AI-slop principles.

ComeOnOliver/skillshub

Auto-loaded context for Portfolio Buddy 2 development. Use for ANY task involving: React 19 development, TypeScript, portfolio analysis features, metrics calculations, trading strategy comparison, or working with the Portfolio Buddy 2 codebase. Contains tech stack, known issues, and architectural constraints.

ComeOnOliver/skillshub

Next.js development tooling via MCP. Inspect routes, components, build info, and debug Next.js apps. Use when working on Next.js applications, debugging routing, or inspecting app structure. NOT for general React or non-Next.js projects.

ComeOnOliver/skillshub

Implement UI using Shadcn MCP (atoms/theme) and 21st.dev MCP (complex sections). Use when adding buttons, layouts, or generating landing pages.

ComeOnOliver/skillshub

A conceptual skill for building an API client in Next.js that handles JWT tokens

ComeOnOliver/skillshub

Best practices and patterns for Next.js App Router, Server Actions, and Routing in this project.

ComeOnOliver/skillshub

The Design System, Theme, and UX rules for the Physical AI Hub.

ComeOnOliver/skillshub

Comprehensive frontend development skill for building modern, performant web applications using ReactJS, NextJS, TypeScript, Tailwind CSS. Includes component scaffolding, performance optimization, bundle analysis, and UI best practices. Use when developing frontend features, optimizing performance, implementing UI/UX designs, managing state, or reviewing frontend code.

ComeOnOliver/skillshub

This document captures learnings from fixing keyboard navigation issues when floating components (Select, DropdownMenu, Popover) have CSS open/close animations.

ComeOnOliver/skillshub

Build Next.js 16 applications with correct patterns and distinctive design. Use when creating pages, layouts, dynamic routes, upgrading from Next.js 15, or implementing proxy.ts. Covers breaking changes (async params/searchParams, Turbopack, cacheComponents) and frontend aesthetics. NOT when building non-React or backend-only applications.

ComeOnOliver/skillshub

Comprehensive Framer Motion animation library for React. Covers motion components, variants, gestures, page transitions, and scroll animations. Use when adding animations to React/Next.js applications.

ComeOnOliver/skillshub

Build interfaces that resonate, not just render. This skill enforces bold, intentional

Skills relacionados