REST API
REST-API
Eine REST-API ist eine HTTP-Schnittstelle, die um Ressourcen wie Bestellungen oder Benutzer aufgebaut ist. Jede Anfrage steht für sich, verwendet die standardmäßigen HTTP-Bedeutungen, kann Caching unterstützen und kann durch mehrere Schichten geleitet werden.
Ein weiteres Beispiel
Eine Lager-App ruft `/orders/784` ab, ändert die Adresse mit einem bedingten `PATCH` und folgt einem `Link`-Header zur Sendungsverfolgung. Jeder zustandslose Server kann die Anfrage bearbeiten. Wenn das `ETag` veraltet ist, gibt der Server 412 zurück, anstatt eine neuere Änderung zu ersetzen.
Hauptteile
- 01Ressourcenkennzeichen
- 02Einheitliche HTTP-Operation
- 03Darstellung und Links
Verwenden Sie es, wenn
Verwenden Sie REST, wenn ressourcenbasierte HTTP, Caching, Mittelschichten und Clients, die sich selbständig ändern können, zum Produkt passen.
Nutze es nicht, wenn
Eine API ist nicht RESTful, nur weil sie JSON über HTTP sendet. Zustandsbehaftete Sitzungen, RPC-Befehls-Tunnel oder ignorierte HTTP-Bedeutungen sind andere Designs.
In Code verwendeter Name
client-server + stateless + cache + uniform interface + layered system + hypermedia Vor dem Ausliefern
Check contracts and invariants, authorization, and input limits. Test retries, one-time effects, timeouts, and partial failures. Verify data integrity, compatibility, monitoring, recovery, and rollback.
Outcome: Complete the task with REST-API (REST API). User context: Eine Lager-App ruft `/orders/784` ab, ändert die Adresse mit einem bedingten `PATCH` und folgt einem `Link`-Header zur Sendungsverfolgung. Jeder zustandslose Server kann die Anfrage bearbeiten. Wenn das `ETag` veraltet ist, gibt der Server 412 zurück, anstatt eine neuere Änderung zu ersetzen. Technical concept or control: REST-API (REST API). Why it fits: Verwenden Sie REST, wenn ressourcenbasierte HTTP, Caching, Mittelschichten und Clients, die sich selbständig ändern können, zum Produkt passen. Do not use it when: Eine API ist nicht RESTful, nur weil sie JSON über HTTP sendet. Zustandsbehaftete Sitzungen, RPC-Befehls-Tunnel oder ignorierte HTTP-Bedeutungen sind andere Designs. Engineering requirements: Define inputs, outputs, contracts, and rules that must always hold. Set authorization and input checks. Define failures, timeouts, retries, one-time effects, data moves, and compatibility limits. Operations: Add useful signals and logs that hide sensitive data. Set capacity limits and write an operator guide. Test recovery and rollback. Acceptance criteria: Contract and failure-path tests pass. Data and authorization rules still hold during retries and partial failures. Check performance limits, monitoring, recovery, and rollback. Evidence and limits (evidence boundary): Kein einziger offizieller Standard kontrolliert den gesamten Begriff. Seine Bedeutung kann sich zwischen Teams, Plattformen oder Frameworks ändern. Unknowns to confirm: Where the code runs, data stores, traffic shape, consistency needs, and the security boundary. Also confirm the compatibility period, service goals, and rollback limits.
Diese Anfrage prüfen
Review how REST-API (REST API) is used now. Definition: Eine REST-API ist eine HTTP-Schnittstelle, die um Ressourcen wie Bestellungen oder Benutzer aufgebaut ist. Jede Anfrage steht für sich, verwendet die standardmäßigen HTTP-Bedeutungen, kann Caching unterstützen und kann durch mehrere Schichten geleitet werden. Release checks: Check contracts and invariants, authorization, and input limits. Test retries, one-time effects, timeouts, and partial failures. Verify data integrity, compatibility, monitoring, recovery, and rollback. Before changing code, list the evidence, gaps, severity, and the smallest safe fix.