Ergebnis dieses Guides
Eine dokumentierte HTTP-Schnittstelle
Arbeitsumgebung
SvelteKit mit der eingesetzten Svelte-Version und dem vorgesehenen Adapter
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.
Trennen Sie Seiten, Layouts, Serverdaten und HTTP-Endpunkte anhand der SvelteKit-Dateikonventionen. Prüfen Sie bei jedem Datenübergang, ob der Wert öffentlich sein darf oder nur auf dem Server benötigt wird.
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 SvelteKit 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
Testen Sie Direktaufruf, clientseitige Navigation und den Adapter des Produktionsbetriebs. Entwicklungsserver und Zielplattform können unterschiedliche Fähigkeiten besitzen.
Beispiel zur Überprüfung
So lässt sich das Ergebnis prüfen.
Als Projektkontext dient ein Kundenportal mit Formularen und geschützten Bereichen. 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.
- Load-Funktionen und Aktionen laufen in unterschiedlichen Kontexten; Berechtigungen 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.
