Communitygithub.com

API 문서 생성기

API 라우트 파일로부터 OpenAPI/Swagger 문서를 자동 생성합니다. REST API, Express 라우트, FastAPI 엔드포인트 작업 시 또는 사용자가 API 문서를 요청할 때 사용하세요.

API 문서 생성기란 무엇인가요?

이 스킬은 코드베이스의 API 라우트 정의 파일을 분석하여 OpenAPI 3.0 (Swagger) 규격 문서를 자동 생성합니다. Express, FastAPI, Flask, NestJS, Rails 등 다양한 프레임워크를 지원하며, 각 프레임워크의 라우트 패턴을 인식하여 HTTP 메서드, 경로, 파라미터, 응답 구조, 인증 정보 등을 추출합니다. 생성된 문서는 `openapi.yaml` 또는 `swagger.json` 형식으로 저장되며, 프로젝트 루트 또는 `docs/`, `api/` 디렉토리에 배치됩니다. 기존 스키마(TypeScript 인터페이스, Pydantic 모델 등)를 활용하여 정확한 스키마를 생성하고, 엔드포인트를 태그로 논리적으로 그룹화하며, 오류 응답 및 보안 요구사항을 포함하여 문서의 완전성을 검증합니다. 이 스킬은 개발자가 API 문서를 수동으로 작성하는 데 드는 시간을 절약하고, 항상 최신 상태의 정확한 문서를 유지할 수 있도록 도와줍니다.

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

즐겨 사용하는 AI에게 물어보기

이 에이전트 스킬이 미리 로드된 새 채팅을 엽니다.

문서

API 문서 생성기은(는) 무엇을 하나요?

이 스킬은 코드베이스의 API 라우트 파일로부터 OpenAPI 3.0 (Swagger) 문서를 자동 생성합니다.

이 스킬을 사용해야 할 때

  • 사용자가 API 문서 생성을 요청할 때
  • REST API 엔드포인트 작업 시
  • OpenAPI/Swagger 명세를 생성하거나 업데이트해야 할 때
  • Express, FastAPI, Flask, NestJS 또는 유사한 프레임워크의 API 문서를 설정할 때

지침

1. API 라우트 발견

코드베이스에서 API 라우트 정의를 검색하세요:

  • Express/Node.js: app.get(), app.post(), router.get() 등을 찾습니다.
  • FastAPI/Python: @app.get(), @router.post() 데코레이터를 찾습니다.
  • Flask: @app.route() 데코레이터를 찾습니다.
  • NestJS: @Get(), @Post(), @Controller() 데코레이터를 찾습니다.
  • Rails: config/routes.rb 파일에서 라우트를 찾습니다.

Glob을 사용하여 라우트 파일을 찾으세요 (예: **/*routes*.{js,ts,py}, **/controllers/**/*.{js,ts}).

2. 라우트 패턴 분석

발견된 각 라우트에 대해 다음을 추출하세요:

  • HTTP 메서드: GET, POST, PUT, PATCH, DELETE
  • 경로: 엔드포인트 URL (예: /api/users/:id)
  • 파라미터: 경로 파라미터, 쿼리 파라미터, 요청 본문
  • 응답: 예상 응답 구조
  • 인증: 인증 필요 여부
  • 설명: 라우트 근처의 주석 또는 docstring

3. OpenAPI 명세 생성

OpenAPI 3.0 명세 파일(일반적으로 openapi.yaml 또는 swagger.json)을 생성하거나 업데이트하세요:

  • templates/openapi-3.0.yaml 템플릿으로 시작
  • 각 라우트를 OpenAPI path 객체에 매핑
  • JSON Schema를 사용하여 요청/응답 스키마 정의
  • 파라미터 정의 포함 (경로, 쿼리, 본문)
  • 감지된 인증 체계 추가 (Bearer, API Key, OAuth2)
  • 태그별로 엔드포인트 그룹화 (예: "Users", "Products", "Auth")

4. 완전성 검증

생성된 문서에 다음이 포함되어 있는지 확인하세요:

  • 발견된 모든 엔드포인트
  • 정확한 HTTP 메서드와 경로
  • 가능한 경우 요청/응답 예제
  • 오류 응답 (400, 401, 404, 500 등)
  • 보안 요구사항

5. 출력 위치

  • 프로젝트 루트에 openapi.yaml로 저장하거나
  • docs/ 또는 api/ 디렉토리가 존재하면 해당 위치에 저장
  • 위치가 명확하지 않은 경우 사용자에게 선호하는 위치를 물어보세요.

프레임워크별 참고 사항

Express/Node.js

  • 인증/유효성 검사에 영향을 줄 수 있는 라우트 미들웨어 확인
  • 요청 유효성 검사기(Joi, express-validator 등) 찾기
  • 엔드포인트 설명을 위한 JSDoc 주석 추출

FastAPI

  • FastAPI는 OpenAPI 문서를 자동 생성하지만, 이 스킬로 더 향상시킬 수 있습니다.
  • 요청/응답 스키마를 위한 Pydantic 모델 추출
  • response_model 및 status_code 파라미터 확인

NestJS

  • 스키마를 위한 DTO (데이터 전송 객체) 찾기
  • Swagger 데코레이터 (@ApiOperation, @ApiResponse) 확인
  • 컨트롤러 및 메서드 데코레이터에서 메타데이터 추출

모범 사례

  1. 기존 스키마 사용: 코드베이스에 TypeScript 인터페이스, Pydantic 모델 등이 있으면 정확한 스키마를 위해 사용하세요.
  2. 예제 포함: 사용 가능한 경우 테스트에서 요청/응답 예제를 추가하세요.
  3. 논리적으로 그룹화: 태그를 사용하여 리소스 또는 기능 영역별로 엔드포인트를 구성하세요.
  4. 적절한 버전 지정: 코드베이스의 API 버전을 사용하세요 (예: "1.0.0").
  5. 설명 추가: 엔드포인트 설명에 코드 주석/docstring을 사용하세요.

지원 파일

  • templates/openapi-3.0.yaml: 기본 OpenAPI 템플릿
  • examples.md: 프레임워크별 예제

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

관련 스킬