Ergebnis dieses Guides
Eine dokumentierte HTTP-Schnittstelle
Arbeitsumgebung
App Router, React und die im Projekt festgehaltene Next.js-Version
Wann ist diese Entscheidung wichtig?
Verbraucher einer API brauchen verlässliche Methoden, Statuscodes und Datenformen. Ein zufällig passender JSON-Block ist noch kein stabiler Vertrag.
Ordnen Sie die betroffene Route ihrer page-, layout- oder route-Datei zu. Markieren Sie die Grenze zu Client Components ausdrücklich; Schreibzugriffe und vertrauliche Konfiguration bleiben auf dem Server.
APIs: Schritt für Schritt.
- 01
Vorbereiten
Definieren Sie erlaubte Methoden, Eingabefelder, Antwortschema und Fehlercodes. Prüfen Sie, ob die Schnittstelle öffentlich oder intern sein muss.
- 02
In Next.js umsetzen
Validieren Sie am Eingang, begrenzen Sie Antwortgrößen und geben Sie keine internen Fehlermeldungen mit Geheimnissen zurück.
- 03
Im tatsächlichen Projekt prüfen
Prüfen Sie neben dem Entwicklungsserver einen Produktionsbuild und einen direkten Routenaufruf. Cache-Verhalten und dynamische APIs müssen zur installierten Version passen.
Beispiel zur Überprüfung
So lässt sich das Ergebnis prüfen.
Als Projektkontext dient eine Website mit Leistungsseiten und einem Anfrageformular. Der folgende Prüffall ist eine Vorlage für diese Aufgabe und kein Bericht über eine Kundenmessung.
- Eingabe / Auslöser
- GET auf eine vorhandene Ressource und POST mit ungültigen Daten
- Erwartetes Ergebnis
- Status, Inhaltstyp und Antwortschema stimmen in beiden Fällen mit dem Vertrag überein.
- Fehler- oder Grenzfall
- Eine nicht erlaubte Methode wird ausdrücklich abgewiesen und löst keine Seiteneffekte aus.
Abnahme und typische Fehler.
- Fehler und unerwartete Antworten werden sichtbar behandelt.
- Eine nicht erlaubte Methode wird ausdrücklich abgewiesen und löst keine Seiteneffekte aus.
- Client- und Servercode brauchen eine klare Grenze; vertrauliche Daten gehören auf den Server.
Typischer Fehler
Externe Schlüssel im Browser oder ungeprüfte Antworten sind riskant.
Quellen und Versionshinweis
Die Anleitung beschreibt das Vorgehen; konkrete APIs, Produktfunktionen und Laufzeitgrenzen müssen zur eingesetzten Version passen. Halten Sie Version, Konfiguration und Prüfergebnis im Projekt fest und vergleichen Sie die verlinkte Dokumentation bei Änderungen.
