Communitygithub.com

ComeOnOliver/skillshub

Gera documentação OpenAPI/Swagger a partir de arquivos de rota de API. Use ao trabalhar com APIs REST, rotas Express, endpoints FastAPI ou quando o usuário solicitar documentação de API.

O que é skillshub?

Esta skill automatiza a geração de documentação OpenAPI 3.0 (Swagger) a partir de arquivos de rota de API presentes no código-fonte do projeto. Ela é útil para desenvolvedores que trabalham com APIs REST em frameworks populares como Express (Node.js), FastAPI (Python), Flask (Python), NestJS (Node.js) e Rails (Ruby), eliminando a tarefa manual de escrever e manter a especificação OpenAPI. A skill descobre automaticamente as rotas da API no código, analisa cada rota para extrair métodos HTTP, caminhos, parâmetros, respostas e requisitos de autenticação, e então gera um arquivo de especificação OpenAPI 3.0 (geralmente `openapi.yaml` ou `swagger.json`) que segue as melhores práticas, incluindo schemas, exemplos e agrupamento lógico por tags. Ela suporta a detecção de padrões específicos de cada framework, como decoradores no FastAPI e NestJS, e pode aproveitar modelos existentes (como interfaces TypeScript ou modelos Pydantic) para criar schemas precisos e completos.

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

Perguntar na sua IA favorita

Abre um novo chat com esta habilidade de agente já pré-carregada.

Documentação

Gerador de Documentação de API

Esta skill gera automaticamente documentação OpenAPI 3.0 (Swagger) a partir de arquivos de rota de API no seu código-fonte.

Quando Usar Esta Skill

  • O usuário solicita gerar documentação de API
  • Trabalhando com endpoints de API REST
  • Necessidade de criar ou atualizar especificações OpenAPI/Swagger
  • Configurando documentação de API para Express, FastAPI, Flask, NestJS ou frameworks similares

Instruções

1. Descobrir Rotas da API

Pesquise no código-fonte por definições de rota de API:

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

Use Glob para encontrar arquivos de rota (ex.: **/*routes*.{js,ts,py}, **/controllers/**/*.{js,ts})

2. Analisar Padrões de Rota

Para cada rota descoberta, extraia:

  • Método HTTP: GET, POST, PUT, PATCH, DELETE
  • Caminho: URL do endpoint (ex.: /api/users/:id)
  • Parâmetros: Parâmetros de caminho, parâmetros de consulta, corpo da requisição
  • Resposta: Estrutura de resposta esperada
  • Autenticação: Se a autenticação é necessária
  • Descrição: Comentários ou docstrings próximos à rota

3. Gerar Especificação OpenAPI

Crie ou atualize um arquivo de especificação OpenAPI 3.0 (normalmente openapi.yaml ou swagger.json):

  • Comece com o modelo de templates/openapi-3.0.yaml
  • Mapeie cada rota para um objeto de caminho OpenAPI
  • Defina schemas de requisição/resposta usando JSON Schema
  • Inclua definições de parâmetros (caminho, consulta, corpo)
  • Adicione esquemas de autenticação se detectados (Bearer, API Key, OAuth2)
  • Agrupe endpoints por tags (ex.: "Usuários", "Produtos", "Auth")

4. Validar Completude

Verifique se a documentação gerada inclui:

  • Todos os endpoints descobertos
  • Métodos HTTP e caminhos precisos
  • Exemplos de requisição/resposta quando possível
  • Respostas de erro (400, 401, 404, 500, etc.)
  • Requisitos de segurança

5. Local de Saída

  • Salve como openapi.yaml na raiz do projeto, ou
  • Coloque no diretório docs/ ou api/ se existirem
  • Pergunte ao usuário pelo local preferido se não estiver claro

Notas Específicas por Framework

Express/Node.js

  • Verifique middlewares de rota que possam afetar autenticação/validação
  • Procure por validadores de requisição (Joi, express-validator, etc.)
  • Extraia comentários JSDoc para descrições de endpoint

FastAPI

  • O FastAPI gera automaticamente documentação OpenAPI, mas esta skill pode aprimorá-la
  • Extraia modelos Pydantic para schemas de requisição/resposta
  • Verifique parâmetros response_model e status_code

NestJS

  • Procure por DTOs (Data Transfer Objects) para schemas
  • Verifique decoradores Swagger (@ApiOperation, @ApiResponse)
  • Extraia metadados de decoradores de controller e método

Melhores Práticas

  1. Use schemas existentes: Se o código-fonte possui interfaces TypeScript, modelos Pydantic ou similares, use-os para schemas precisos
  2. Inclua exemplos: Adicione exemplos de requisição/resposta de testes, se disponíveis
  3. Agrupe logicamente: Organize endpoints por recurso ou área de funcionalidade usando tags
  4. Versione adequadamente: Use a versão da API do código-fonte (ex.: "1.0.0")
  5. Adicione descrições: Use comentários de código/docstrings para descrições de endpoint

Arquivos de Suporte

  • templates/openapi-3.0.yaml: Modelo base OpenAPI
  • examples.md: Exemplos específicos por framework

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

Habilidades Relacionadas