RESTful-API-Tutorial
In der modernen Webentwicklung sind RESTful APIs zum Standardweg geworden, damit Anwendungen miteinander kommunizieren.
REST (Representational State Transfer) ist ein Softwarearchitekturstil, der 2000 von Dr. Roy Fielding vorgeschlagen wurde.
REST definiert eine Reihe von Einschränkungen und Prinzipien für die Erstellung skalierbarer, lose gekoppelter Webdienste.
Eine RESTful API ist eine API, die nach dem REST-Architekturstil entworfen wurde. Sie nutzt die Eigenschaften des HTTP-Protokolls, um Ressourcen über URLs zu lokalisieren, und verwendet HTTP-Methoden (GET, POST usw.), um Operationen zu beschreiben, wodurch die Interaktion zwischen Client und Server ermöglicht wird.
Für wen ist dieses Tutorial gedacht?
Ob Sie ein Frontend-Entwickler sind, der mit Backend-APIs interagieren muss, oder ein Backend-Entwickler, der API-Schnittstellen entwerfen muss – die Beherrschung von RESTful APIs ist eine unverzichtbare Fähigkeit.
Merkmale einer RESTful API?
Hauptmerkmale:
- Zustandslos: Jede Anfrage enthält alle für die Verarbeitung benötigten Informationen
- Einheitliche Schnittstelle: Verwendet standardmäßige HTTP-Methoden für Operationen
- Ressourcenorientiert: Alles wird als Ressourcen abstrahiert
- Cachefähig: Antworten sollten explizit angeben, ob sie cachefähig sind
Kernprinzipien einer RESTful API
1. Ressourcen und URIs
In REST wird alles als Ressource abstrahiert, und jede Ressource hat eine eindeutige Kennung (URI).
URI-Design-Richtlinien:
- Verwenden Sie Substantive statt Verben, um Ressourcen darzustellen
- Verwenden Sie Pluralformen für Sammlungen
- Verwenden Sie Kleinbuchstaben und Bindestriche (-)
- Dateiendungen vermeiden
Beispiel:
/users # 用户集合 /users/123 # ID为123的用户 /users/123/orders # 用户123的订单集合
2. Verwendung von HTTP-Methoden
RESTful APIs nutzen die Semantik der HTTP-Methoden vollständig aus:
| HTTP-Methode | Beschreibung | Idempotenz | Sicherheit |
|---|---|---|---|
| GET | Ressource abrufen | Ja | Ja |
| POST | Ressource erstellen | nein | nein |
| PUT | Ressource vollständig aktualisieren | Ja | nein |
| PATCH | Ressource teilweise aktualisieren | nein | nein |
| DELETE | Ressource löschen | Ja | nein |
3. Zustandslosigkeit
Jede Anfrage muss alle für die Verarbeitung erforderlichen Informationen enthalten, und der Server speichert keinen Clientzustand. Dadurch lässt sich die API einfach skalieren und die Last verteilen.
4. Repräsentationsformen
Ressourcen können mehrere Repräsentationsformen haben (z. B. JSON, XML), und der Client gibt das gewünschte Format über den Accept-Header an.
Andere Erweiterungen