What is docfy-ui

Motivation

Die meisten OpenAPI-UIs sind für Menschen gebaut, die eine Seite überfliegen – das falsche Format für die andere Zielgruppe, die Dokumentation heute liest: ein LLM, in das du Kontext einfügst. Die Details eines Endpunkts zu kopieren bedeutet meist, rohes JSON zu greifen (weitschweifig, voller $ref und Rauschen) oder gerendertes HTML zu kopieren (verliert die Struktur).

Beispiel: Copy for AI

## Create a user
POST /users

### Request
{
  "name": "string",
  "email": "string"
}

### Responses
201 Created (UserEntity)
400 Bad Request

### Validation
- name: required, minLength 2
- email: required, format email

docfy-ui rendert diesen Text deterministisch aus demselben OpenAPI-Dokument, das jede Swagger UI ohnehin schon ausliefert, ohne zusätzliche Annotationen und ohne Backend-Änderungen.

Features

• Copy for AI: jeder Endpunkt bekommt mit einem Klick eine LLM-fertige Klartext-Zusammenfassung (Zweck, Request, Responses, Validierungsregeln) statt rohem JSON.
• Copy OpenAPI: kopiert das dereferenzierte, zyklensichere JSON-Fragment für genau den ausgewählten Endpunkt.
• Two-column endpoint view: Dokumentation links (Parameter, Responses, navigierbarer Schema-Baum), Codebeispiele rechts (curl, JavaScript, Python, Go).
• Real-time search: filtert die Sidebar bei jedem Tastendruck nach Pfad/Summary/OperationId, kein Debounce, kein Enter nötig.
• Dark/light theme: tokengesteuert, wechselt sofort ohne Reload und ohne Flackern beim ersten Rendern.
• Zero backend coupling: ruft clientseitig ein OpenAPI-3.0/3.1-JSON-Dokument ab; funktioniert mit jedem Server, der eins bereitstellt, nicht nur NestJS.
• Mobile-responsive: Off-Canvas-Drawer unterhalb des lg-Breakpoints, geprüft bei 375/390/768px.
• Compare specs: füg zwei Spec-URLs ein und sieh hinzugefügte/entfernte/geänderte Endpunkte, jeweils als breaking oder informativ markiert.
• Multi-spec switcher: durchstöbere mehrere Services aus einer Instanz, wenn der Host mehr als eine Spec konfiguriert, sonst komplett ausgeblendet.