Démarrer avec NestJS : Un guide pas à pas avec un exemple concret

Introduction

NestJS est un puissant framework pour le développement d’applications côté serveur avec Node.js. Si vous débutez avec NestJS et que vous souhaitez vous lancer, ce guide étape par étape vous accompagnera avec un exemple pratique. En suivant ce guide, vous acquérirez une compréhension solide des concepts de NestJS et apprendrez comment construire une application de base à partir de zéro.

Prérequis

Avant de plonger dans NestJS, assurez-vous d’avoir Node.js et npm (Node Package Manager) installés sur votre machine. Vous pouvez les télécharger depuis le site officiel de Node.js (https://nodejs.org). Une fois que vous avez configuré Node.js et npm, vous êtes prêt à commencer.

Étape 1

Configuration du projet Commencez par créer un nouveau répertoire pour votre projet NestJS. Ouvrez un terminal et rendez-vous dans l’emplacement souhaité. Exécutez la commande suivante pour créer un nouveau projet NestJS à l’aide de Nest CLI :

$ npx @nestjs/cli new nest-example

Cette commande générera une nouvelle structure de projet NestJS dans le répertoire “nest-example”. Une fois la commande terminée, accédez au répertoire du projet :

$ cd nest-example

Étape 2

Création d’un contrôleur Les contrôleurs gèrent les requêtes entrantes et définissent les routes de votre application. Générez un nouveau contrôleur en utilisant Nest CLI :

$ nest generate controller example

Cette commande créera un nouveau fichier de contrôleur nommé “example.controller.ts” ainsi qu’un fichier de test unitaire correspondant.

Étape 3

Définition des routes Ouvrez le fichier “example.controller.ts” dans votre éditeur de code préféré. À l’intérieur de la classe du contrôleur, définissez une route GET simple qui renvoie une réponse JSON :

import { Controller, Get } from '@nestjs/common';

@Controller('example')
export class ExampleController {
  @Get()
  getExample(): string {
    return 'Bonjour, NestJS !';
  }
}

Étape 4

Lancement de l’application Pour démarrer votre application NestJS, exécutez la commande suivante :

$ npm run start

Cette commande va compiler votre code TypeScript et démarrer l’application. Vous devriez voir un message indiquant que l’application s’exécute avec succès.

Étape 5

Tester la route Ouvrez votre navigateur web et accédez à l’adresse “http://localhost:3000/example". Vous devriez voir la réponse “Bonjour, NestJS !” affichée sur la page. Félicitations ! Vous avez créé avec succès une application NestJS de base avec une route fonctionnelle.

Étape 6

Ajout d’un service Les services gèrent la logique métier de votre application. Générez un nouveau service en utilisant Nest CLI :

$ nest generate service example

Cette commande créera un nouveau fichier de service nommé “example.service.ts” ainsi qu’un fichier de test unitaire correspondant.

Étape 7

Injection du service dans le contrôleur Ouvrez à nouveau le fichier “example.controller.ts”. Importez le service nouvellement généré et injectez-le dans le constructeur du contrôleur :

import { Controller, Get } from '@nestjs/common';
import { ExampleService } from './example.service';

@Controller('example')
export class ExampleController {
  constructor(private readonly exampleService: ExampleService) {}
  @Get()
  getExample(): string {
    return this.exampleService.getHello();
  }
}

Étape 8

Implémentation du service Ouvrez le fichier “example.service.ts”. Modifiez la classe du service pour inclure une méthode “getHello” :

import { Injectable } from '@nestjs/common';

@Injectable()
export class ExampleService {
  getHello(): string {
    return 'Bonjour, service NestJS !';
  }
}

Étape 9

Tester l’application mise à jour Redémarrez votre application NestJS en l’arrêtant avec Ctrl + C dans le terminal, puis en exécutant npm run start à nouveau. Rafraîchissez votre navigateur à l'adresse "http://localhost:3000/example" et vous devriez maintenant voir la réponse "Bonjour, service NestJS !" affichée.

Conclusion

Dans cet article, nous avons suivi un guide pas à pas sur la façon de démarrer avec NestJS. En suivant l’exemple, vous avez appris comment configurer un projet, créer des contrôleurs, définir des routes, ajouter des services et les injecter dans les contrôleurs. Cette base vous permettra de construire des applications plus complexes en utilisant NestJS. Explorez la documentation officielle de NestJS (https://docs.nestjs.com) pour découvrir d’autres fonctionnalités et approfondir vos connaissances sur le framework. Bon codage avec NestJS !