Communitygithub.com

Générateur de documentation API

Génère automatiquement la documentation OpenAPI/Swagger à partir des fichiers de routes API de votre codebase. À utiliser avec des API REST, des routes Express, des endpoints FastAPI ou lorsque l'utilisateur demande une documentation API.

Qu'est-ce que Générateur de documentation API ?

Cette compétence permet de générer automatiquement une spécification OpenAPI 3.0 (Swagger) complète et précise en analysant les définitions de routes API dans votre codebase. Elle prend en charge les frameworks populaires tels que Express (Node.js), FastAPI (Python), Flask, NestJS et Rails, et extrait les méthodes HTTP, chemins, paramètres, schémas de requête/réponse, exigences d'authentification et métadonnées issues des commentaires ou décorateurs. Idéale pour les développeurs et équipes qui souhaitent maintenir une documentation API à jour sans effort manuel, elle supporte l'intégration avec les systèmes de validation existants (Joi, Pydantic, DTO NestJS) et permet de sauvegarder le fichier `openapi.yaml` dans le dossier racine ou un répertoire dédié. La compétence valide également l'exhaustivité de la documentation en vérifiant la couverture de tous les endpoints, la présence d'exemples et les réponses d'erreur standards.

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

Demander à votre IA préférée

Ouvre une nouvelle conversation avec cette compétence d'agent déjà préchargée.

Documentation

Que fait Générateur de documentation API ?

Cette compétence génère automatiquement la documentation OpenAPI 3.0 (Swagger) à partir des fichiers de routes API de votre codebase.

Quand utiliser cette compétence

  • L'utilisateur demande de générer une documentation API
  • Vous travaillez avec des endpoints API REST
  • Vous devez créer ou mettre à jour des spécifications OpenAPI/Swagger
  • Vous mettez en place une documentation API pour Express, FastAPI, Flask, NestJS ou des frameworks similaires

Instructions

1. Découvrir les routes API

Recherchez dans le codebase les définitions de routes API :

  • Express/Node.js : Recherchez app.get(), app.post(), router.get(), etc.
  • FastAPI/Python : Recherchez @app.get(), @router.post(), décorateurs
  • Flask : Recherchez les décorateurs @app.route()
  • NestJS : Recherchez les décorateurs @Get(), @Post(), @Controller()
  • Rails : Recherchez les routes dans config/routes.rb

Utilisez Glob pour trouver les fichiers de routes (ex : **/*routes*.{js,ts,py}, **/controllers/**/*.{js,ts})

2. Analyser les modèles de route

Pour chaque route découverte, extrayez :

  • Méthode HTTP : GET, POST, PUT, PATCH, DELETE
  • Chemin : L'URL de l'endpoint (ex : /api/users/:id)
  • Paramètres : Paramètres de chemin, paramètres de requête, corps de la requête
  • Réponse : Structure de réponse attendue
  • Authentification : Si l'authentification est requise
  • Description : Commentaires ou docstrings près de la route

3. Générer la spécification OpenAPI

Créez ou mettez à jour un fichier de spécification OpenAPI 3.0 (généralement openapi.yaml ou swagger.json) :

  • Commencez avec le modèle de templates/openapi-3.0.yaml
  • Mappez chaque route à un objet de chemin OpenAPI
  • Définissez les schémas de requête/réponse en utilisant JSON Schema
  • Incluez les définitions de paramètres (chemin, requête, corps)
  • Ajoutez les schémas d'authentification si détectés (Bearer, API Key, OAuth2)
  • Regroupez les endpoints par balises (ex : "Utilisateurs", "Produits", "Authentification")

4. Valider l'exhaustivité

Vérifiez que la documentation générée inclut :

  • Tous les endpoints découverts
  • Des méthodes HTTP et chemins précis
  • Des exemples de requête/réponse si possible
  • Des réponses d'erreur (400, 401, 404, 500, etc.)
  • Les exigences de sécurité

5. Emplacement de sortie

  • Enregistrez sous openapi.yaml à la racine du projet, ou
  • Placez dans le répertoire docs/ ou api/ s'ils existent
  • Demandez à l'utilisateur l'emplacement préféré en cas de doute

Notes spécifiques aux frameworks

Express/Node.js

  • Vérifiez les middleware de route qui pourraient affecter l'authentification/validation
  • Recherchez les validateurs de requête (Joi, express-validator, etc.)
  • Extrayez les commentaires JSDoc pour les descriptions d'endpoints

FastAPI

  • FastAPI génère automatiquement des docs OpenAPI, mais cette compétence peut les améliorer
  • Extrayez les modèles Pydantic pour les schémas de requête/réponse
  • Vérifiez les paramètres response_model et status_code

NestJS

  • Recherchez les DTO (Data Transfer Objects) pour les schémas
  • Vérifiez les décorateurs Swagger (@ApiOperation, @ApiResponse)
  • Extrayez les métadonnées des décorateurs de contrôleur et de méthode

Bonnes pratiques

  1. Utilisez les schémas existants : Si le codebase contient des interfaces TypeScript, des modèles Pydantic ou similaires, utilisez-les pour des schémas précis
  2. Incluez des exemples : Ajoutez des exemples de requête/réponse à partir des tests si disponibles
  3. Regroupez logiquement : Organisez les endpoints par ressource ou domaine fonctionnel à l'aide de balises
  4. Versionnez correctement : Utilisez la version de l'API du codebase (ex : "1.0.0")
  5. Ajoutez des descriptions : Utilisez les commentaires de code/docstrings pour les descriptions d'endpoints

Fichiers associés

  • templates/openapi-3.0.yaml : Modèle OpenAPI de base
  • examples.md : Exemples spécifiques aux frameworks

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 associés