Ergebnis dieses Guides
Eine dokumentierte HTTP-Schnittstelle
Arbeitsumgebung
Angular mit der vorhandenen Router-, Formular- und Buildkonfiguration
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 Verhalten einer Komponente und wiederverwendbare fachliche Zugriffe einer klaren Schnittstelle zu. Berücksichtigen Sie beim Router und bei Datenströmen, wann eine Komponente neu aufgebaut oder verlassen 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 Angular 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 Navigation, zerstörte Komponenten und laufende Datenabonnements. Falls serverseitiges Rendering verwendet wird, muss der benötigte Inhalt auch vor der Browserinteraktion verfügbar sein.
Beispiel zur Überprüfung
So lässt sich das Ergebnis prüfen.
Als Projektkontext dient ein internes Dashboard mit Rollen und vielen Datenansichten. 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.
- Eine klare Modul- und Zuständigkeitsstruktur ist wichtiger als möglichst viele Abstraktionen.
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.
