Ergebnis dieses Guides
Eine dokumentierte HTTP-Schnittstelle
Arbeitsumgebung
Astro mit ausdrücklich gewählten interaktiven Komponenten und gegebenenfalls Serveradapter
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.
Beginnen Sie mit der serverseitig erzeugten Inhaltsseite. Ergänzen Sie Browserinteraktion nur an den benötigten Inseln und prüfen Sie deren Ladeverhalten. Statische Ausgabe und serverseitige Funktionen benötigen passende Betriebsentscheidungen.
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 Astro 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
Rufen Sie den Inhalt ohne JavaScript auf und aktivieren Sie danach die interaktive Funktion. Beide Ausgaben müssen dieselbe fachliche Information vermitteln.
Beispiel zur Überprüfung
So lässt sich das Ergebnis prüfen.
Als Projektkontext dient einen Ratgeber mit vielen Artikeln und wenigen interaktiven Elementen. 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.
- Nicht jede Komponente braucht JavaScript im Browser; Interaktivität sollte bewusst aktiviert werden.
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.
