Démarrage

Ce guide vous permettra de créer votre première API en quelques minutes seulement.

Prérequis

Avant de commencer, assurez-vous d'avoir :

• Node.js (version 18 ou supérieure) - Télécharger ici
• Gestionnaire de paquets npm ou yarn
• Connaissances de base en TypeScript

Vous pouvez vérifier votre version de Node.js avec :

node --version

Démarrage rapide

Créons votre première API YasuiJS en 3 étapes simples.

Étape 1 : Installer YasuiJS

Créez un nouveau répertoire et installez YasuiJS :

mkdir my-yasui-api
cd my-yasui-api
npm init -y
npm install yasui
npm install -D typescript @types/node

Étape 2 : Configurer TypeScript

Créez un fichier tsconfig.json :

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true
  }
}

Étape 3 : Créer votre première API

Créez app.ts :

import yasui, { Controller, Get } from 'yasui';

@Controller('/')
export class AppController {
  @Get('/')
  hello() {
    return { message: 'Hello World!' };
  }
}

yasui.createServer({
  controllers: [AppController]
});

Étape 4 : Exécuter votre API

Ajoutez des scripts à votre package.json :

{
  "scripts": {
    "build": "tsc",
    "start": "node dist/app.js",
    "dev": "tsc && node dist/app.js"
  }
}

Compilez et exécutez votre API :

npm run dev

Visitez http://localhost:3000 et vous verrez :

{ "message": "Hello World!" }

Félicitations ! Vous avez une API YasuiJS fonctionnelle.

Exemples

Consultez les exemples complets dans le dépôt YasuiJS pour plus de modèles et de cas d'utilisation.

Besoin d'aide ?

Si vous rencontrez des problèmes :

1. Assurez-vous que votre tsconfig.json contient experimentalDecorators: true
2. Vérifiez que vous utilisez la syntaxe d'importation correcte
3. Vérifiez vos versions de TypeScript et Node.js
4. Consultez la sortie de la console pour des messages d'erreur détaillés