Communitygithub.com

API-Dokumentationsgenerator

Generiert OpenAPI/Swagger-Dokumentation aus API-Routendateien. Verwenden bei REST-APIs, Express-Routen, FastAPI-Endpunkten oder wenn der Benutzer API-Dokumentation anfordert.

Was ist API-Dokumentationsgenerator?

Dieser Skill analysiert automatisch API-Routendefinitionen in deiner Codebasis und generiert daraus eine vollständige OpenAPI 3.0 (Swagger) Spezifikation. Er unterstützt eine Vielzahl von Frameworks wie Express, FastAPI, Flask, NestJS und Rails und extrahiert HTTP-Methoden, Pfade, Parameter, Authentifizierungsschemata und erwartete Antwortstrukturen. Der generierte Output (standardmäßig openapi.yaml) kann im Projektstamm oder in einem docs/-Verzeichnis gespeichert werden. Der Skill ist ideal für Entwickler, die schnell und konsistent eine aktuelle API-Dokumentation erstellen oder aktualisieren möchten, ohne manuell Spezifikationen schreiben zu müssen.

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

In Ihrer bevorzugten KI fragen

Öffnet einen neuen Chat, in dem dieser Agent-Skill bereits geladen ist.

Dokumentation

Was macht API-Dokumentationsgenerator?

Dieser Skill generiert automatisch OpenAPI 3.0 (Swagger) Dokumentation aus API-Routendateien in deiner Codebasis.

Wann dieser Skill verwendet werden sollte

  • Benutzer bittet um API-Dokumentation
  • Arbeiten mit REST-API-Endpunkten
  • Erstellen oder Aktualisieren von OpenAPI/Swagger-Spezifikationen
  • Einrichten von API-Dokumentation für Express, FastAPI, Flask, NestJS oder ähnliche Frameworks

Anleitung

1. API-Routen entdecken

Durchsuche die Codebasis nach API-Routendefinitionen:

  • Express/Node.js: Suche nach app.get(), app.post(), router.get() usw.
  • FastAPI/Python: Suche nach @app.get(), @router.post() Dekorateuren
  • Flask: Suche nach @app.route() Dekorateuren
  • NestJS: Suche nach @Get(), @Post(), @Controller() Dekorateuren
  • Rails: Suche nach Routen in config/routes.rb

Verwende Glob, um Routendateien zu finden (z.B. **/*routes*.{js,ts,py}, **/controllers/**/*.{js,ts})

2. Routenmuster analysieren

Extrahiere für jede gefundene Route:

  • HTTP-Methode: GET, POST, PUT, PATCH, DELETE
  • Pfad: Die Endpunkt-URL (z.B. /api/users/:id)
  • Parameter: Pfadparameter, Abfrageparameter, Request-Body
  • Antwort: Erwartete Antwortstruktur
  • Authentifizierung: Ob eine Authentifizierung erforderlich ist
  • Beschreibung: Kommentare oder Docstrings in der Nähe der Route

3. OpenAPI-Spezifikation generieren

Erstelle oder aktualisiere eine OpenAPI 3.0 Spezifikationsdatei (üblicherweise openapi.yaml oder swagger.json):

  • Beginne mit der Vorlage aus templates/openapi-3.0.yaml
  • Ordne jede Route einem OpenAPI-Pfadobjekt zu
  • Definiere Anfrage-/Antwort-Schemata mit JSON-Schema
  • Füge Parameterdefinitionen ein (Pfad, Abfrage, Body)
  • Füge Authentifizierungsschemata hinzu, falls erkannt (Bearer, API-Key, OAuth2)
  • Gruppiere Endpunkte nach Tags (z.B. "Benutzer", "Produkte", "Auth")

4. Vollständigkeit überprüfen

Prüfe, ob die generierte Dokumentation Folgendes enthält:

  • Alle gefundenen Endpunkte
  • Korrekte HTTP-Methoden und Pfade
  • Beispiele für Anfragen/Antworten, soweit möglich
  • Fehlerantworten (400, 401, 404, 500 usw.)
  • Sicherheitsanforderungen

5. Ausgabeort

  • Speichern als openapi.yaml im Projektstammverzeichnis, oder
  • Platzieren im Verzeichnis docs/ oder api/, falls vorhanden
  • Benutzer nach bevorzugtem Ort fragen, falls unklar

Framework-spezifische Hinweise

Express/Node.js

  • Prüfe auf Middleware, die Authentifizierung/Validierung beeinflussen könnte
  • Suche nach Request-Validatoren (Joi, express-validator usw.)
  • Extrahiere JSDoc-Kommentare für Endpunktbeschreibungen

FastAPI

  • FastAPI generiert automatisch OpenAPI-Docs, dieser Skill kann sie jedoch verbessern
  • Extrahiere Pydantic-Modelle für Anfrage-/Antwort-Schemata
  • Prüfe auf Parameter wie response_model und status_code

NestJS

  • Suche nach DTOs (Data Transfer Objects) für Schemata
  • Prüfe auf Swagger-Dekorateure (@ApiOperation, @ApiResponse)
  • Extrahiere Metadaten aus Controller- und Methodendekorateuren

Best Practices

  1. Vorhandene Schemata verwenden: Falls die Codebasis TypeScript-Interfaces, Pydantic-Modelle oder ähnliches enthält, verwende sie für genaue Schemata
  2. Beispiele einfügen: Füge Anfrage-/Antwort-Beispiele aus Tests hinzu, falls verfügbar
  3. Logisch gruppieren: Organisiere Endpunkte nach Ressource oder Feature-Bereich mithilfe von Tags
  4. Versionierung korrekt durchführen: Verwende die API-Version aus der Codebasis (z.B. "1.0.0")
  5. Beschreibungen hinzufügen: Verwende Code-Kommentare/Docstrings für Endpunktbeschreibungen

Unterstützende Dateien

  • templates/openapi-3.0.yaml: Basis-OpenAPI-Vorlage
  • examples.md: Framework-spezifische Beispiele

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

Verwandte Skills