nestjs-doc

Un module pour générer automatiquement la documentation de vos routes/microservices NestJS à partir de décorateurs personnalisés.

Installation

npm install nestjs-doc

Utilisation

1. Importer le module dans votre application

import { DocModule } from "nestjs-doc";

@Module({
  imports: [DocModule],
})
export class AppModule {}

2. Utiliser le décorateur @Doc sur vos handlers

import { Doc } from 'nestjs-doc';

export class MyDto {
  // ...
}

@Controller()
export class MyController {
  @MessagePattern({ cmd: 'my-action' })
  @Doc({
    summary: 'Résumé de l\'action',
    input: MyDto,
    output: "ok",
    description: 'Description détaillée de l'action',
  })
  myAction(data: MyDto): string {
    return 'ok';
  }
}

3. Génération automatique de la documentation

Au démarrage de l'application, un fichier doc.json sera généré à la racine du projet avec la documentation de tous les handlers décorés.

API

Décorateur @Doc(options)

• summary (string, requis) : Résumé de l'action
• pattern (string, optionnel) : Pattern du message (déduit automatiquement si absent)
• input (any, optionnel) : Type d'entrée (DTO)
• output (any, optionnel) : Type de sortie
• description (string, optionnel) : Description détaillée

Service DocService

Le service est automatiquement lancé au démarrage du module et génère le fichier de documentation.

Contribution

Les contributions sont les bienvenues !

Licence

MIT