Toolverse
All skills
Backend

generating-api-docs

by jeremylongshore

Create comprehensive API documentation with examples, authentication guides, and SDKs.\nUse when creating comprehensive API documentation.\nTrigger with phrases like \

Installation

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

Installation

Quick info

Author
jeremylongshore
Category
Backend
Views
21
GitHub repo

About this skill

Create comprehensive API documentation with examples, authentication guides, and SDKs.\nUse when creating comprehensive API documentation.\nTrigger with phrases like \

How to use

  1. Przygotuj specyfikację OpenAPI 3.0+ zawierającą opisy wszystkich operacji, parametrów oraz przykłady żądań i odpowiedzi dla każdego endpointu.
  2. Wczytaj specyfikację za pomocą funkcji Read i sprawdź kompletność dokumentacji — upewnij się, że każda operacja ma summary, description, opisy parametrów i co najmniej jeden przykład.
  3. Wzbogać specyfikację o szczegółowe opisy w formacie Markdown, dodając przewodniki wprowadzające, wyjaśnienia przepływu uwierzytelniania i dokumentację limitów szybkości w sekcji info.description lub rozszerzeniach x-documentation.
  4. Wygeneruj interaktywną dokumentację używając Redoc lub Stoplight Elements z funkcją "Try It", która pozwala użytkownikom wykonywać żądania bezpośrednio ze strony dokumentacji.
  5. Utwórz przykłady kodu dla każdego endpointu w wielu językach programowania, wykorzystując generator przykładów kodu.
  6. Wdróż wygenerowaną dokumentację na statycznym hostingu (GitHub Pages, Netlify, Vercel) z niestandardowym brandingiem, nawigacją wersjonowaną i wyszukiwaniem pełnotekstowym.

Related skills

youtube-transcript

by michalparkola

Download YouTube video transcripts when user provides a YouTube URL or asks to download/get/fetch a transcript from YouTube. Also use when user wants to transcribe or get captions/subtitles from a YouTube video.

Backend
53214

architecture-decision-records

by wshobson

Write and maintain Architecture Decision Records (ADRs) following best practices for technical decision documentation. Use when documenting significant technical decisions, reviewing past architectural choices, or establishing decision processes.

Backend
29130

api-design-principles

by wshobson

Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers. Use when designing new APIs, reviewing API specifications, or establishing API design standards.

Backend
50146

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

postgresql-psql

by timelessco

Comprehensive guide for PostgreSQL psql - the interactive terminal client for PostgreSQL. Use when connecting to PostgreSQL databases, executing queries, managing databases/tables, configuring connection options, formatting output, writing scripts, managing transactions, and

Backend
34173

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