Zum Inhalt springen
KendorDocs

So betreibst du ein Frontend und eine API zusammen in einer Coding-Aufgabe

Für Aufgabenautoren ·

Definiere jeden Teil als Dienst in kendor.yaml mit eigenem Ordner, eigenen Befehlen und Port, wähle den Vorschau-Dienst und route Pfade wie /api zur API.

Eine Aufgabe kann mehrere Prozesse nebeneinander ausführen, etwa ein React-Frontend und eine API. Gib jedem einen Eintrag unter services in kendor.yaml mit seinem Ordner (workDir), seinen Befehlen und seinem Port, nenne in preview.service den Dienst, den die Vorschau zeigt, und füge routing hinzu, damit Anfragen an /api die API erreichen, während alles andere das Frontend erreicht. Jeder Dienst läuft in derselben Sandbox.

Ein vollständiges Beispiel

Ein Repository mit einem Vite-Frontend in web/ und einer Express-API in api/, gestützt auf 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

Wie die Dienste starten

  1. Zuerst starten die Datenbanken.
  2. Das install der obersten Ebene läuft einmal im Workspace-Stamm, falls es eines gibt.
  3. Jeder Dienst führt seine eigenen install-Befehle in seinem workDir aus, dann seinen dev-Befehl.

Jeder Dienst bekommt ein eigenes Prozessfenster, benannt nach dem Dienst, und erscheint in der Ansicht Prozesse, wo der Kandidat ihn stoppen, starten und neu starten kann.

workDir

workDir ist der Ordner, in dem die Install-, Dev- und Test-Befehle eines Dienstes laufen, relativ zum Workspace-Stamm. Lass es für einen Dienst im Stammverzeichnis weg. Es darf nicht mit / beginnen oder .. enthalten.

Einmal oder pro Dienst installieren

Bei getrennten Paketen gehört npm ci (oder pip install, composer install) in das install jedes Dienstes. Bei einem Monorepo mit einem Lockfile im Stammverzeichnis, etwa einem pnpm-Workspace, verwende stattdessen das install der obersten Ebene, damit die Abhängigkeiten nur einmal installiert werden:

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

Gib jedem Dienst, der HTTP ausliefert, einen dev.port. Kendor setzt PORT darauf und HOST auf 0.0.0.0 für den Dev-Befehl dieses Dienstes, sodass --port $PORT beides synchron hält. Zwei Dienste können nicht denselben Port verwenden.

Die Vorschau und das Routing

preview.service ist der Dienst, den der Vorschau-Bereich des Kandidaten öffnet. Er ist Pflicht, sobald es mehr als einen Dienst gibt.

routing ordnet Pfadpräfixe auf der Vorschau-Adresse Diensten zu. Das längste passende Präfix gewinnt, mit den obigen Routen geht also /api/products an api und jeder andere Pfad an web. Der Pfad wird nicht umgeschrieben: Die API erhält /api/products, binde ihre Routen daher unter /api ein. Da Frontend und API sich eine Adresse teilen, stellt der Browser Same-Origin-Requests, und es ist kein CORS einzurichten.

Solange ein gerouteter Dienst noch startet, etwa während die API ihre Migrationen ausführt, zeigt die Vorschau eine kurze Warteseite, statt ein Frontend zu laden, dessen erste API-Aufrufe fehlschlagen würden.

Jeder Dienst mit Port kann außerdem in der Ansicht Prozesse unter seiner eigenen Adresse geöffnet werden.

Die URL eines Dienstes an einen anderen weitergeben

Der Browser erreicht die Sandbox über ihre Vorschau-Adresse, nicht über localhost. Kendor leitet die meisten Browser-Aufrufe an http://localhost:<port> für dich um (siehe localhost in der Vorschau), der verlässliche Weg ist aber eine Referenz in dev.env.vars:

Referenz Wird aufgelöst zu
routing.api.url Die Vorschau-Adresse plus die Route der API, zum Beispiel https://<preview-address>/api
routing.web.url Die Vorschau-Adresse selbst, da web unter / geroutet ist. Die obige API nutzt sie als APP_URL, für Links, die sie zurück zum Frontend baut.
databases.postgres.url Die PostgreSQL-Verbindungs-URL
lit:<text> Fester Text

Kendor löst diese auf, bevor ein Dienst startet, die Reihenfolge, in der die Dienste hochkommen, spielt also keine Rolle. Eine Referenz auf einen Dienst, der nicht existiert, besteht die Validierung beim Speichern nicht.

Für Server-zu-Server-Aufrufe innerhalb der Sandbox funktioniert http://localhost:3000 weiterhin.

publicEnvPrefix

publicEnvPrefix vermerkt, welche Variablen für Browser-Code gedacht sind, etwa VITE_ bei Vite. Kendor speichert es, wertet es aber heute nicht aus; Vite selbst gibt nur VITE_-Variablen an das Bundle weiter.

Vite-Frontends

Vite blockiert Anfragen für Hostnamen, die es nicht kennt, darunter die Vorschau-Adresse der Sandbox. Das Plugin @kendordev/vite behebt das und richtet Hot Reload auf die richtige Adresse aus. Es wirkt nur innerhalb einer Kendor-Sandbox und lässt sich daher bedenkenlos einchecken.

Wenn du ein Zip hochlädst oder ein Repository mit einer vite.config im Stammverzeichnis importierst, fügt Kendor das Plugin für dich hinzu. Bei einer Vite-App in einem Unterordner, wie web/ oben, fügst du es selbst hinzu:

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()],
});

Installiere es mit npm install -D @kendordev/vite und checke das aktualisierte Lockfile ein.

Tests über mehrere Dienste

Der Tab Tests führt standardmäßig das test.command des Vorschau-Dienstes aus. Liegen die Tests in einem anderen Dienst, wie bei api oben, setze kendor.gradeService auf diesen Dienst. Um die Tests mehrerer Dienste auszuführen, liste sie in kendor.gradeServices auf; jeder läuft in seinem eigenen workDir, und die Ergebnisse erscheinen als service › test.

War dieser Artikel hilfreich?