Zum Hauptinhalt springen

Was den header in der REST-Antwort enthält: Die 65 am häufigsten verwendeten Felder

Der Header oder Header ist einer der wichtigsten Teile einer HTTP-Antwort. Es enthält Informationen über die Antwort selbst, ihre Parameter und das Format. In der REST-Architektur wird header verwendet, um zusätzliche Daten zu senden, die nicht zum Hauptinhalt der Antwort gehören.

Der Header in der REST-Antwort kann eine Vielzahl von Feldern enthalten. Einige werden zum Sichern, Authentifizieren und Autorisieren verwendet, andere zum Zwischenspeichern von Daten oder zum Angeben des Inhaltstyps der Antwort. Alle diese Felder sind ein Schlüssel-Wert-Paar, wobei der Schlüssel der Name des Feldes und der Wert der Inhalt des Feldes ist.

In diesem Artikel werden wir uns die 65 am häufigsten verwendeten header-Felder in der REST-Antwort ansehen. Dazu gehören wichtige Felder wie der Content-Type, der den Typ der im Antworttext übergebenen Daten angibt, oder Location, der den neuen Speicherort der angeforderten Ressource angibt. Außerdem betrachten wir die Felder, die für das Zwischenspeichern, Komprimieren und Authentifizieren von Anforderungen zuständig sind.

Die Kenntnis dieser Header-Felder in der REST-Antwort ist eine wichtige Fähigkeit für den API-Entwickler. Es hilft beim Aufbau effizienterer und sichererer Systeme und ermöglicht eine effizientere Verarbeitung und Übertragung von Daten zwischen Client und Server.

Dies ist nur eine kleine Liste der am häufigsten verwendeten Header-Felder in der REST-Antwort. Die spezifischen Felder können von der spezifischen Implementierung der API und ihren Zielen abhängen.

Hauptdaten:

  • Content-Type: gibt das Format des Antwortinhalts an, z. B. "application/json" oder "text/html".
  • Status: gibt einen Antwortstatuscode an, z. B. 200 (OK), 404 (Not Found) oder 500 (Internal Server Error).
  • Cache-Control: steuert das Zwischenspeichern der Antwort, indem angegeben wird, welche Daten im Cache gespeichert werden können.
  • Location: gibt den neuen Speicherort der Ressource an, wenn die Umleitung ausgeführt wird.
  • Content-Length: gibt die Größe der Antwort in Bytes an.
  • Allow: gibt die HTTP-Methoden an, die für diese Ressource zulässig sind.
  • Last-Modified: gibt das Datum und die Uhrzeit der letzten Änderung der Ressource an.
  • ETag: enthält einen eindeutigen Bezeichner für die Ressourcenversion, um die Integrität zu überprüfen.
  • Server: enthält Informationen über den Server, auf dem die API oder die Webanwendung ausgeführt wird.

Alle diese Felder können verwendet werden, um REST-API-Antworten zu verwalten und zu analysieren und die Interaktion zwischen Client und Server zu erleichtern.

Haupttypen:

Der Header in der REST-Antwort enthält viele Felder, die zum Übertragen verschiedener Daten und Informationen verwendet werden können. Zu den wichtigsten Feldtypen, die im header gefunden werden können, gehören:

  • Content-Type: Gibt den Typ und das Format der Daten an, die im Antworttext zurückgegeben werden. Der application/json-Typ gibt beispielsweise an, dass die Daten im JSON-Format vorliegen.
  • Content-Length: Gibt die Länge des Antwortkörpers in Bytes an.
  • Cache-Control: legt fest, wie und wie lange eine Antwort zwischengespeichert werden kann. Mit dem Wert public können Sie beispielsweise eine clientseitige Antwort zwischenspeichern, während der Wert private nur clientseitig ist.
  • Date: Gibt das Datum und die Uhrzeit an, zu der die Antwort erstellt wurde.
  • Server: enthält Informationen über den Server, auf dem die API ausgeführt wird.
  • Location: Wird verwendet, um den Client zu einer neuen Ressource oder URL umzuleiten.
  • ETag: enthält eine eindeutige Versions-ID der Ressource, die bei der Kontrolle des Caching hilft.

Dies sind nur einige der am häufigsten verwendeten Feldtypen, die im Header einer REST-Antwort auftreten können. Sie stellen verschiedene Metadaten und Informationen bereit, die für den Kunden bei der Interaktion mit der API nützlich sein können.

Systemparameter:

In der Antwort eines REST-Servers können viele Systemparameter an den header übergeben werden, mit denen Clients mit dem Server kommunizieren können. Einige der am häufigsten verwendeten Systemeinstellungen umfassen:

ParameterDie Beschreibung
Content-TypeGibt den vom Server zurückgegebenen Inhaltstyp an
Content-LengthGibt die Größe des Antwortkörpers in Bytes an
DateZeigt das Datum und die Uhrzeit an, zu der die Antwort erstellt wurde
Cache-ControlGibt an, wie der Client die Antwort zwischenspeichern soll
ExpiresGibt die Zeit an, nach der die Antwort als veraltet gilt und aktualisiert werden muss
ServerZeigt Informationen über den Server an, auf dem die Ressource gespeichert ist
Set-CookieSetzt ein Cookie auf der Clientseite
ConnectionGibt an, ob eine Verbindung mit der Seite hergestellt werden soll
LocationGibt die URL an, an die der Client weitergeleitet werden soll
Access-Control-Allow-OriginBestimmt, welche Domänen Zugriff auf die Ressource haben

Dies ist nur ein kleiner Satz von Systemparametern, die an den Antwortheader des REST-Servers übergeben werden können. Jeder dieser Parameter kann seine eigenen eindeutigen Werte haben und in bestimmten Situationen verwendet werden.