Typescript/NestJS: Validate API Parameters with Class-Validator & Class-Transformer
Zusammenfassung
Kurz
Der Beitrag zeigt, wie NestJS mit `class-validator`, `class-transformer` und einer globalen `ValidationPipe` API-Eingaben prüft, in DTOs umwandelt und Fehlermeldungen anpasst. Codebeispiele behandeln unter anderem Typen, verschachtelte Objekte, optionale und bedingte Werte sowie eine beispielhafte 400-Antwort; der Artikel ist eine Einführung mit ausgewählten Dekoratoren und setzt NestJS-Grundkenntnisse voraus.
Mittel
Der Artikel erklärt, wie `class-validator` und `class-transformer` in NestJS zur Prüfung von API-Eingaben und zur Umwandlung einfacher JavaScript-Objekte in DTO-Klassen eingesetzt werden. Er zeigt Dekoratoren für Typen, Formate, Grenzwerte und Arraygrößen. Mit `each: true` gelten Regeln für alle Einträge; `ValidateNested` prüft verschachtelte Objekte, wobei `Type` den Zieltyp für die Umwandlung angibt. `IsOptional` überspringt weitere Prüfungen bei fehlenden oder `null`-Werten, während `ValidateIf` sie an eine Bedingung knüpft.
Eine globale `ValidationPipe` kann laut Beitrag die Validierung übernehmen. `transform: true` aktiviert dabei die DTO-Umwandlung. Genannte Optionen erlauben unter anderem, nicht dekorierte Eigenschaften zu entfernen, beim ersten Fehler abzubrechen oder über `exceptionFactory` eigene Ausnahmen zu erzeugen. Ein gezeigter POST-Endpunkt liefert bei leerem Request beispielhaft eine 400-Antwort mit Validierungsfehlern; die Ausgabe hängt laut Autor von DTO und Konfiguration ab. Meldungen lassen sich pro Regel fest oder dynamisch festlegen oder gesammelt über `exceptionFactory` anpassen. Der Beitrag setzt NestJS-Grundkenntnisse voraus, zeigt nur eine Auswahl von Dekoratoren und behandelt eigene Exception-Filter und Validatoren nicht im Detail.
Ausführlich lesen
Der Bericht zeigt, wie sich API-Eingaben in NestJS mit `class-validator` und `class-transformer` prüfen und in DTO-Klassen umwandeln lassen. Er richtet sich an Leserinnen und Leser, die grundlegende NestJS-Kenntnisse haben. Laut Artikel bietet `class-validator` Prüfungen über Dekoratoren und nutzt intern `validator.js`; `class-transformer` wandelt einfache JavaScript-Objekte in Klasseninstanzen um. Für reine Validierung genüge die erste Bibliothek, für Netzwerkdaten und DTOs sei zusätzlich die Transformation nützlich.
Anhand von Codebeispielen führt der Autor Dekoratoren für grundlegende Typen wie Zeichenketten, boolesche Werte, Zahlen, Daten, Arrays und Objekte vor. Weitere Dekoratoren prüfen etwa E-Mail- und URL-Formate, Mindest- und Höchstwerte, Zeichenkettenlängen oder Arraygrößen. Mit der Option `each: true` lassen sich Regeln auf jedes Element einer Sammlung anwenden. Verschachtelte Objekte werden laut Artikel mit `ValidateNested` geprüft; `Type` aus `class-transformer` gibt dabei den Zielklassentyp für die Umwandlung an. `IsOptional` überspringt die übrigen Prüfungen, wenn ein Wert fehlt oder `null` ist. Mit `ValidateIf` können Prüfungen von einer Bedingung abhängig gemacht werden.
Für die automatische Prüfung richtet der Artikel eine globale NestJS-`ValidationPipe` ein. Die Option `transform: true` schaltet dem Beispiel zufolge die Umwandlung in DTO-Klassen ein. `enableDebugMessages` soll zusätzliche Warnungen ausgeben; mit `exceptionFactory` lässt sich aus den Validierungsfehlern eine eigene Ausnahme erzeugen. Der Autor nennt außerdem Optionen wie `whitelist`, die Eigenschaften ohne Validierungsdekoration entfernen soll, und `stopAtFirstError`, die nach dem ersten Fehler abbrechen soll. Anschließend wird eine DTO-Klasse als Typ des Request-Bodys eines POST-Endpunkts verwendet. Für einen leeren Request zeigt der Artikel beispielhaft eine Bad-Request-Antwort mit Statuscode 400 und mehreren Validierungsfehlern; die konkrete Ausgabe könne je nach DTO und Konfiguration variieren.
Zum Anpassen von Meldungen beschreibt der Bericht zwei Wege: Eine einzelne Regel kann eine feste oder dynamisch berechnete Nachricht erhalten, wobei die Funktion unter anderem auf den geprüften Wert und die Eigenschaft zugreifen kann. Für eine eigene Meldung über alle Fehler hinweg kann `exceptionFactory` die Fehlerliste verarbeiten. Eigene Exception-Filter und benutzerdefinierte Validatoren werden erwähnt, aber nicht ausgeführt.
Der Beitrag ist eine Einführung mit ausgewählten Beispielen, keine vollständige Referenz: Er verweist für alle verfügbaren Dekoratoren auf die Dokumentation und setzt NestJS-Grundwissen voraus. Er berichtet keine systematischen Tests oder Messungen; die Resultate werden anhand von Code und einer beispielhaften HTTP-Fehlerantwort erläutert.
Gegengeprüft von Claude Haiku 5.5: ok
Lunas Einordnung enthält keine Sammel- oder Teilfragen, daher bleibt die Liste leer. Die Zusammenfassungen (kurz und mittel) stimmen mit dem Bericht überein; die Kürzungen sind vertretbar und es gibt keine erfundenen Angaben.
Im Bericht, aber nicht in der Zusammenfassung
- Die Aussage des Beitrags, dass class-validator allein für reine Parametervalidierung genügt, während class-transformer für die Umwandlung der Netzwerk-Payloads in DTO-Klassen nötig ist
Wie die Modelle den Bericht einordnen
Ansicht
Filter
Kein Modell sieht bei diesem Bericht einen Bezug zu einer der 44 Sammelfragen.