Documentar uma API existente

Adote nestjs-docfy incrementalmente em um projeto Nest com Swagger já configurado.

Passos

  1. Instale o pacote (ver Instalação).
  2. Registre DocfyModule.forRoot() no AppModule.
  3. Adicione @WithDocs() em um controller existente.
  4. Rode npx nestjs-docfy generate (ou --dry-run primeiro, para conferir o que seria escrito) para gerar o *.controller.docs.ts ao lado do controller, já pré-preenchido com summaries e responses inferidos via docs(), sem tocar na lógica do controller.
  5. Edite o arquivo gerado para completar o que for específico do seu domínio.
  6. Rode npx nestjs-docfy coverage para medir o progresso e itere.
  7. Quando estiver ok, habilite DocfyModule.forRoot({ strict: true }) para que qualquer controller marcado sem docs file falhe no startup.