Documentation API (Swagger)

L'API expose sa documentation OpenAPI via @nestjs/swagger, montée sur /sso (hors préfixe /api — useGlobalPrefix non activé).

  • Local : http://localhost:3000/sso
  • Prod : https://connect.article-1.eu/sso

Génération des schémas

Le plugin compilateur @nestjs/swagger est activé dans back/nest-cli.json (introspectComments: true). Il génère automatiquement les schémas de requête/réponse pour tous les DTOs à partir des types TS et des décorateurs class-validator, sans besoin de @ApiProperty manuel.

Pour ajouter un exemple de payload sur un champ, utiliser un commentaire JSDoc @example au-dessus de la propriété :

/**
 * Email de l'utilisateur
 * @example "jean.dupont@article-1.eu"
 */
@IsEmail()
email: string;

Piège : nest-cli.json n'est lu qu'au démarrage du process. Une modif de ce fichier (ex. options du plugin) nécessite un restart complet de yarn start:dev, pas juste un rebuild déclenché par le watch.