Toolverse
All skills
Backend

api-documentation-generator

by davila7

Generate comprehensive, developer-friendly API documentation from code, including endpoints, parameters, examples, and best practices

Installation

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

Installation

Quick info

Author
davila7
Category
Backend
Views
32
GitHub repo

About this skill

Generate comprehensive, developer-friendly API documentation from code, including endpoints, parameters, examples, and best practices

How to use

  1. Przygotuj kod Twojego API — upewnij się, że masz dostęp do plików źródłowych zawierających definicje endpointów, routy, parametry i logikę autentykacji.

  2. Uruchom skill i wskaż ścieżkę do kodu API — skill przeanalizuje strukturę Twojego API, identyfikując dostępne endpointy, metody HTTP (GET, POST, PUT, DELETE), parametry żądań, formaty odpowiedzi, kody statusu oraz wymagania autentykacji.

  3. Skill wygeneruje dokumentację dla każdego endpointa — obejmie ona opis funkcji, wymagania autentykacji, informacje o rate limitingu, specyfikację parametrów ścieżki i query, nagłówki, schemat body żądania oraz wszystkie możliwe odpowiedzi z kodami błędów.

  4. Przejrzyj wygenerowane przykłady kodu — dokumentacja będzie zawierać polecenia cURL oraz przykłady w JavaScript/TypeScript, Python i innych językach, aby ułatwić integrację.

  5. Dodaj wytyczne użytkownika — skill dołączy przewodnik szybkiego startu, instrukcje konfiguracji autentykacji, typowe przypadki użycia oraz najlepsze praktyki obsługi błędów.

  6. Eksportuj dokumentację w wybranym formacie — możesz uzyskać specyfikację OpenAPI/Swagger lub dokumentację w formacie gotowym do publikacji dla deweloperów i użytkowników zewnętrznych.

Related skills

fastapi-templates

by wshobson

Create production-ready FastAPI projects with async patterns, dependency injection, and comprehensive error handling. Use when building new FastAPI applications or setting up backend API projects.

Backend
327582

supabase-developer

by daffy0208

Build full-stack applications with Supabase (PostgreSQL, Auth, Storage, Real-time, Edge Functions). Use when implementing authentication, database design with RLS, file storage, real-time features, or serverless functions.

Backend
78170

travel-planner

by ailabs-393

This skill should be used whenever users need help planning trips, creating travel itineraries, managing travel budgets, or seeking destination advice. On first use, collects comprehensive travel preferences including budget level, travel style, interests, and dietary

Backend
4379

context-optimizer

by openclaw

Advanced context management with auto-compaction and dynamic context optimization for DeepSeek's 64k context window. Features intelligent compaction (merging, summarizing, extracting), query-aware relevance scoring, and hierarchical memory system with context archive. Logs

Backend
2964

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

video-downloader

by ComposioHQ

Downloads videos from YouTube and other platforms for offline viewing, editing, or archival. Handles various formats and quality options.

Backend
50173