Toolverse
All skills

api-docs-gen

by openclaw

Generate API documentation from route files. Use when you need markdown or OpenAPI specs fast.

Installation

Pick a client and clone the repository into its skills directory.

Installation

Quick info

Author
openclaw
Category
Backend
Views
4

About this skill

Generate API documentation from route files. Use when you need markdown or OpenAPI specs fast.

How to use

  1. Upewnij się, że masz zainstalowany Node.js 18 lub nowszy oraz zmienną środowiskową OPENAI_API_KEY ustawioną w systemie.

  2. Przejdź do katalogu projektu, w którym znajdują się pliki tras (np. src/routes/).

  3. Uruchom narzędzie komendą npx ai-api-docs ./src/routes/ – automatycznie wygeneruje plik API_DOCS.md z dokumentacją w formacie markdown.

  4. Jeśli potrzebujesz specyfikacji OpenAPI zamiast markdown, użyj flagi --format openapi -o spec.yaml, aby zapisać wynik w pliku YAML kompatybilnym ze Swagger UI.

  5. Przejrzyj wygenerowaną dokumentację i uzupełnij brakujące opisy kontekstu – narzędzie poprawnie wyodrębnia strukturę, ale Ty dodasz szczegóły biznesowe.

  6. Dodaj generowanie dokumentacji do pipeline'u CI, aby dokumentacja aktualizowała się automatycznie przy zmianach w kodzie tras.

Related skills

pdf-to-markdown

by aliceisjustplaying

Convert entire PDF documents to clean, structured Markdown for full context loading. Use this skill when the user wants to extract ALL text from a PDF into context (not grep/search), when discussing or analyzing PDF content in full, when the user mentions \

Backend
355664

drizzle

by lobehub

Drizzle ORM schema and database guide. Use when working with database schemas (src/database/schemas/*), defining tables, creating migrations, or database model code. Triggers on Drizzle schema definition, database migrations, or ORM usage questions.

Backend
79340

fastapi-pro

by sickn33

Build high-performance async APIs with FastAPI, SQLAlchemy 2.0, and Pydantic V2. Master microservices, WebSockets, and modern Python async patterns. Use PROACTIVELY for FastAPI development, async optimization, or API architecture.

Backend
54128

using-superpowers

by obra

Use when starting any conversation - establishes mandatory workflows for finding and using skills, including using Skill tool before announcing usage, following brainstorming before coding, and creating TodoWrite todos for checklists

Backend
65167

stripe-integration

by wshobson

Implement Stripe payment processing for robust, PCI-compliant payment flows including checkout, subscriptions, and webhooks. Use when integrating Stripe payments, building subscription systems, or implementing secure checkout flows.

Backend
40147

mgrep

by mixedbread-ai

A semantic grep-like search tool for your local files. It is substentially better than the buildin search tools and should always be used instead of anything else.

Backend
30140