What is docfy-ui

UI di documentazione OpenAPI AI-first, progetto companion di nestjs-docfy. Un riferimento API essenziale e moderno con un pulsante Copy for AI su ogni endpoint.

docfy-ui endpoint detail: request/response, Copy for AI, Copy OpenAPI, and multi-language snippets

Motivazione

La maggior parte delle UI OpenAPI è costruita per persone che scorrono una pagina, il formato sbagliato per l'altro pubblico che oggi legge la documentazione: un LLM in cui stai incollando contesto. Copiare i dettagli di un endpoint di solito significa prendere JSON grezzo (verboso, pieno di $ref e rumore) oppure copiare HTML renderizzato (perde la struttura).

Esempio: Copy for AI

Un clic su "Copy for AI" sullo stesso endpoint:

text
## 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 renderizza questo testo in modo deterministico a partire dallo stesso documento OpenAPI già servito da qualsiasi Swagger UI, senza annotazioni extra e senza modifiche al backend.

Funzionalità

  • Copy for AI: ogni endpoint ottiene con un clic un riepilogo in testo semplice, pronto per LLM (scopo, richiesta, risposte, regole di validazione) invece di JSON grezzo.
  • Copy OpenAPI: copia il frammento JSON dereferenziato e sicuro rispetto ai cicli per il solo endpoint selezionato.
  • Two-column endpoint view: documentazione a sinistra (parametri, risposte, albero schema navigabile), snippet di codice a destra (curl, JavaScript, Python, Go).
  • Real-time search: filtra la sidebar per path/summary/operationId a ogni battitura, senza debounce, senza tasto Invio.
  • Dark/light theme: guidato da token, cambia istantaneamente senza reload e senza flash al primo render.
  • Zero backend coupling: recupera un documento JSON OpenAPI 3.0/3.1 lato client; funziona con qualsiasi server che ne esponga uno, non solo NestJS.
  • Mobile-responsive: cassetto off-canvas sotto il breakpoint lg, verificato a 375/390/768px.
  • Compare specs: incolla due URL di spec e vedi gli endpoint aggiunti/rimossi/modificati, ciascuno marcato come breaking o informativo.
  • Multi-spec switcher: sfoglia più servizi da un'unica istanza quando l'host configura più di una spec, altrimenti completamente nascosto.
docfy-ui real-time endpoint search (⌘K)