What is docfy-ui
Interface de documentation OpenAPI pensée pour l'IA, projet compagnon de nestjs-docfy. Une référence API épurée et moderne, avec un bouton Copy for AI sur chaque endpoint.
Motivation
La plupart des interfaces OpenAPI sont conçues pour des humains qui parcourent une page, ce qui est le mauvais format pour l'autre public qui lit la documentation aujourd'hui : un LLM dans lequel tu colles du contexte. Copier les détails d'un endpoint veut généralement dire récupérer du JSON brut (verbeux, plein de $ref et de bruit) ou copier du HTML rendu (qui perd la structure).
Exemple : Copy for AI
Un clic sur « Copy for AI » sur le même endpoint :
## 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 emaildocfy-ui génère ce texte de façon déterministe à partir du même document OpenAPI que n'importe quelle Swagger UI sert déjà, sans annotation supplémentaire et sans changement backend.
Fonctionnalités
- Copy for AI: chaque endpoint obtient un résumé en texte brut prêt pour un LLM en un clic (objectif, requête, réponses, règles de validation) au lieu de JSON brut.
- Copy OpenAPI: copie le fragment JSON déréférencé et sûr en cas de cycle, pour seulement l'endpoint sélectionné.
- Two-column endpoint view: documentation à gauche (paramètres, réponses, arbre de schéma navigable), extraits de code à droite (curl, JavaScript, Python, Go).
- Real-time search: filtre la sidebar par chemin/résumé/operationId à chaque frappe, sans debounce, sans touche Entrée.
- Dark/light theme: piloté par tokens, bascule instantanément sans rechargement et sans flash au premier affichage.
- Zero backend coupling: récupère un document JSON OpenAPI 3.0/3.1 côté client ; fonctionne avec tout serveur qui en expose un, pas seulement NestJS.
- Mobile-responsive: tiroir hors-écran en dessous du breakpoint
lg, testé à 375/390/768px. - Compare specs: colle deux URLs de spec et vois les endpoints ajoutés/supprimés/modifiés, chacun marqué breaking ou informationnel.
- Multi-spec switcher: parcours plusieurs services depuis une seule instance quand l'hôte configure plus d'une spec, sinon complètement masqué.
