Aller au contenu
KendorDocs

Comment exécuter un frontend et une API ensemble dans un même exercice de code

Pour les auteurs d’exercices ·

Définissez chaque partie comme un service dans kendor.yaml avec son dossier, ses commandes et son port, choisissez le service d’aperçu, et routez des chemins comme /api vers l’API.

Un exercice peut exécuter plusieurs processus côte à côte, comme un frontend React et une API. Donnez à chacun une entrée sous services dans kendor.yaml avec son dossier (workDir), ses commandes et son port, indiquez dans preview.service celui que l’aperçu affiche, et ajoutez routing pour que les requêtes vers /api atteignent l’API pendant que tout le reste atteint le frontend. Tous les services s’exécutent dans le même bac à sable.

Un exemple complet

Un dépôt avec un frontend Vite dans web/ et une API Express dans api/, adossés à PostgreSQL :

kendor.yaml
version: 1
runtime:
  type: node
  version: "22"
databases:
  - type: postgres
    version: "18"
    init: api/db/seed.sql
services:
  api:
    workDir: api
    install:
      commands:
        - npm ci
    dev:
      command: node --watch src/server.js
      port: 3000
      env:
        vars:
          APP_URL: routing.web.url
    test:
      command: node --test
  web:
    workDir: web
    install:
      commands:
        - npm ci
    dev:
      command: npm run dev -- --port $PORT
      port: 5173
      env:
        vars:
          VITE_API_URL: routing.api.url
    publicEnvPrefix: VITE_
preview:
  service: web
routing:
  - path: /api
    service: api
  - path: /
    service: web
kendor:
  gradeService: api

Comment les services démarrent

  1. Les bases de données démarrent en premier.
  2. L’install de premier niveau s’exécute une fois à la racine de l’espace de travail, s’il y en a une.
  3. Chaque service exécute ses propres commandes install dans son workDir, puis sa commande dev.

Chaque service obtient sa propre fenêtre de processus, nommée d’après le service, qui apparaît dans la vue Processus où le candidat peut l’arrêter, le démarrer et le redémarrer.

workDir

workDir est le dossier dans lequel s’exécutent les commandes d’installation, dev et de test d’un service, relatif à la racine de l’espace de travail. Omettez-le pour un service à la racine. Il ne peut ni commencer par / ni contenir ...

Installer une fois ou par service

Pour des paquets séparés, placez npm ci (ou pip install, composer install) dans l’install de chaque service. Pour un monorepo avec un seul fichier de verrouillage à la racine, comme un espace de travail pnpm, utilisez plutôt l’install de premier niveau, afin que les dépendances ne soient installées qu’une fois :

kendor.yaml
version: 1
runtime:
  type: node
  version: "22"
install:
  commands:
    - pnpm install --frozen-lockfile
services:
  api:
    workDir: apps/api
    dev:
      command: pnpm dev
      port: 3000
  web:
    workDir: apps/web
    dev:
      command: pnpm dev --port $PORT
      port: 5173
preview:
  service: web
routing:
  - path: /api
    service: api
  - path: /
    service: web

Ports

Donnez un dev.port à chaque service qui sert du HTTP. Kendor y fixe PORT et fixe HOST à 0.0.0.0 pour la commande dev de ce service, de sorte que --port $PORT garde les deux synchronisés. Deux services ne peuvent pas utiliser le même port.

L’aperçu et le routage

preview.service est le service que le volet d’aperçu du candidat ouvre. Il est obligatoire dès qu’il y a plus d’un service.

routing associe des préfixes de chemin de l’adresse d’aperçu à des services. Le préfixe qui correspond le plus longuement l’emporte : avec les routes ci-dessus, /api/products va vers api et tout autre chemin va vers web. Le chemin n’est pas réécrit : l’API reçoit /api/products, montez donc ses routes sous /api. Comme le frontend et l’API partagent une seule adresse, le navigateur fait des requêtes de même origine et il n’y a aucun CORS à configurer.

Tant qu’un service routé démarre encore, par exemple pendant que l’API exécute ses migrations, l’aperçu affiche une courte page d’attente au lieu de charger un frontend dont les premiers appels à l’API échoueraient.

Tout service doté d’un port peut aussi être ouvert sur sa propre adresse depuis la vue Processus.

Transmettre l’URL d’un service à un autre

Le navigateur atteint le bac à sable via son adresse d’aperçu, pas localhost. Kendor redirige pour vous la plupart des appels du navigateur vers http://localhost:<port> (voir localhost dans l’aperçu), mais la méthode fiable est une référence dans dev.env.vars :

Référence Se résout en
routing.api.url L’adresse d’aperçu suivie de la route de l’API, par exemple https://<preview-address>/api
routing.web.url L’adresse d’aperçu elle-même, puisque web est routé sur /. L’API ci-dessus l’utilise comme APP_URL, pour les liens qu’elle construit vers le frontend.
databases.postgres.url L’URL de connexion PostgreSQL
lit:<text> Un texte fixe

Kendor les résout avant le démarrage de tout service : l’ordre dans lequel les services démarrent n’a donc pas d’importance. Une référence à un service qui n’existe pas échoue à la validation lors de l’enregistrement.

Pour les appels de serveur à serveur dans le bac à sable, http://localhost:3000 fonctionne toujours.

publicEnvPrefix

publicEnvPrefix indique quelles variables sont destinées au code navigateur, comme VITE_ pour Vite. Kendor le stocke mais n’en tient pas compte aujourd’hui ; Vite lui-même n’expose au bundle que les variables VITE_.

Frontends Vite

Vite bloque les requêtes dont il ne connaît pas le nom d’hôte, ce qui inclut l’adresse d’aperçu du bac à sable. Le plugin @kendordev/vite corrige cela et dirige le rechargement à chaud vers la bonne adresse. Il n’agit qu’à l’intérieur d’un bac à sable Kendor : vous pouvez donc le versionner sans risque.

Quand vous importez un zip ou un dépôt avec un vite.config à la racine, Kendor ajoute le plugin à votre place. Pour une application Vite dans un sous-dossier, comme web/ ci-dessus, ajoutez-le vous-même :

web/vite.config.js
import { defineConfig } from 'vite';
import react from '@vitejs/plugin-react';
import kendor from '@kendordev/vite';

export default defineConfig({
  plugins: [react(), kendor()],
});

Installez-le avec npm install -D @kendordev/vite et versionnez le fichier de verrouillage mis à jour.

Tests sur plusieurs services

L’onglet Tests exécute par défaut la test.command du service d’aperçu. Quand les tests se trouvent dans un autre service, comme api ci-dessus, définissez kendor.gradeService sur ce service. Pour exécuter les tests de plusieurs services, listez-les dans kendor.gradeServices ; chacun s’exécute dans son propre workDir et les résultats apparaissent sous la forme service › test.

Cet article vous a-t-il aidé ?