Die MANUELL geschriebenen Typen aus Kapitel 75 GERATEN aus dem Takt, SOBALD sich die API ändert – openapi-typescript generiert sie STATTDESSEN AUTOMATISCH aus der Spezifikation aus Kapitel 17.

Das Werkzeug installieren

npm install --save-dev openapi-typescript

Die Generierung als npm-Script

{
  "scripts": {
    "generate-types": "openapi-typescript https://localhost/api/docs.jsonopenapi --output src/types/api.ts"
  }
}

docs.jsonopenapi ist API Platforms JSON-Endpunkt für die ROHE OpenAPI-Spezifikation (GENAU der Inhalt aus Kapitel 17s api:openapi:export, hier DIREKT über HTTP statt per Konsole abgerufen).

npm run generate-types

Die generierten Typen verwenden

import type { components } from '../types/api';

type Project = components['schemas']['Project.jsonld-project.read'];
type ProjectCollection = components['schemas']['Project.jsonld-project.read.collection'];

Die generierten Typnamen ENTHALTEN die Serialisierungsgruppe (Kapitel 23) – SICHTBARER Beweis, dass die generierten Typen EXAKT widerspiegeln, WELCHE Felder in WELCHER Situation tatsächlich vorhanden sind, statt eine PAUSCHALE Annahme zu treffen.

Den manuellen Typ ersetzen

// hooks/useProjects.ts - VORHER (Kapitel 75)
import type { ProjectCollection } from '../types/project';

// NACHHER
import type { components } from '../types/api';
type ProjectCollection = components['schemas']['Project.jsonld-project.read.collection'];

Automatisierung als Ausblick

In einem REALEN Team würde generate-types Teil des CI-Workflows sein (Block 11-12 vertieft Deployment) – ÄNDERT sich die API-Struktur, SCHLÄGT ein tsc-Typcheck FEHL, statt STILLSCHWEIGEND falsche Annahmen im Frontend zu verschleiern.