1. MDN Web Docs
  2. Schreibrichtlinien
  3. Seitenstrukturen
  4. Seitentypen
  5. HTTP-Header-Seitenschablone

Dieser Inhalt wurde automatisch aus dem Englischen übersetzt, und kann Fehler enthalten. Erfahre mehr über dieses Experiment.

View in English Always switch to English

HTTP-Header-Seitenschablone

Hinweis: Entfernen Sie diese ganze erklärende Anmerkung vor der Veröffentlichung

Seitenvorbemerkungen:

Die Vorbemerkungen am Anfang der Seite werden verwendet, um "Seitenmetadaten" zu definieren. Die Werte sollten entsprechend für den jeweiligen Header aktualisiert werden.

md
---
title: NameOfTheHeader Header
short-title: NameOfTheHeader
slug: Web/HTTP/Reference/Headers/NameOfTheHeader
page-type: http-header
status:
  - deprecated
  - experimental
  - non-standard
browser-compat: path.to.feature.NameOfTheHeader
sidebar: http
---
title

Überschrift, die oben auf der Seite angezeigt wird. Formatieren Sie als NameOfTheHeader Header. Zum Beispiel hat der Cache-Control Header einen title von Cache-Control Header.

short-title

Kurztitel, der in Brotkrümeln und Seitenleisten verwendet wird. Formatieren Sie als NameOfTheHeader. Zum Beispiel hat der Cache-Control Header einen short-title von Cache-Control.

slug

Das Ende des URL-Pfads nach https://developer.mozilla.org/de/docs/. Dies wird wie Web/HTTP/Reference/Headers/NameOfTheHeader formatiert. Zum Beispiel ist der Slug des Cache-Control Headers Web/HTTP/Reference/Headers/Cache-Control.

page-type

Für HTTP-Header muss http-header verwendet werden. Für andere HTTP page-type Werte siehe den HTTP-Bereich der Dokumentation für den page-type Vorbemerkungsschlüssel.

status

Kennzeichnungen, die den Status dieses Features beschreiben. Ein Array, das eines oder mehrere der folgenden enthalten kann: experimental, deprecated, non-standard. Dieser Schlüssel sollte nicht manuell gesetzt werden: Er wird automatisch basierend auf den Werten in den Browser-Kompatibilitätsdaten für das Feature gesetzt. Siehe "Wie Feature-Status hinzugefügt oder aktualisiert werden".

browser-compat

Ersetzen Sie den Platzhalterwert path.to.feature.NameOfTheHeader mit der Abfragezeichenfolge für den Header im Browser-Compat-Daten-Repo. Die Toolchain verwendet automatisch den Schlüssel, um den Kompatibilitätsbereich zu füllen (Ersetzen des {{Compat}} Makros).

Beachten Sie, dass Sie möglicherweise zuerst einen Eintrag für den HTTP-Header in unserem Browser-Compat-Daten-Repo erstellen/aktualisieren müssen, und der Eintrag für den Header muss Spezifikationsinformationen enthalten. Siehe unseren Leitfaden dazu.

Browser-Kompatibilität gilt nicht für HTTP-Header, bei denen keine spezifische Implementierung bereitgestellt wird (wie das automatische Hinzufügen eines Anforderungsheaders zu einigen Anfragen oder das Ändern des Verhaltens basierend auf Daten in einem Antwortheader). In diesen Fällen entfernen Sie den browser-compat Schlüssel und Wert.

Dies ist immer http. Siehe Seitenstrukturen: Seitenleisten für Details.

Top-der-Seite Makros

Eine Reihe von Makros erscheinen oben im Inhaltsbereich unmittelbar nach den Seitenvorbemerkungen. Diese Makros werden automatisch durch Tools hinzugefügt, daher vermeiden Sie es, sie hinzuzufügen oder zu entfernen:

  • {{SeeCompatTable}} — dieses generiert ein Dies ist eine experimentelle Technologie Banner, das anzeigt, dass der Header experimentell ist. Wenn es experimentell ist und die Technologie hinter einem Einstellung in Firefox versteckt ist, sollten Sie dafür auch einen Eintrag auf der Experimentelle Features in Firefox Seite ausfüllen.
  • {{deprecated_header}} — dieses generiert ein Veraltet Banner, das anzeigt, dass die Nutzung des Headers nicht empfohlen wird.
  • {{Non-standard_Header}} — dieses generiert ein Nicht-standardisiert Banner, das anzeigt, dass das Feature zu keiner Spezifikation gehört.

Stellen Sie keine Statusheader-Makros manuell bereit. Verweisen Sie auf den Abschnitt "Wie Feature-Status hinzugefügt oder aktualisiert werden", um diese Status zur Seite hinzuzufügen.

Beispiele für die Experimentelle, Veraltete und Nicht-standardisierte Banner werden direkt nach diesem Anmerkungsblock angezeigt.

Denken Sie daran, diese ganze erklärende Anmerkung vor der Veröffentlichung zu entfernen

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Veraltet: Diese Funktion wird nicht mehr empfohlen. Obwohl einige Browser sie möglicherweise noch unterstützen, könnte sie bereits aus den relevanten Webstandards entfernt worden sein, in Kürze entfernt werden oder nur noch aus Kompatibilitätsgründen bestehen. Vermeiden Sie die Verwendung und aktualisieren Sie vorhandenen Code, falls möglich; siehe die Kompatibilitätstabelle am Ende dieser Seite, um Ihre Entscheidung zu unterstützen. Beachten Sie, dass diese Funktion jederzeit aufhören könnte zu funktionieren.

Nicht standardisiert: Diese Funktion ist nicht standardisiert. Wir raten davon ab, nicht-standardisierte Funktionen auf produktiven Webseiten zu verwenden, da sie nur von bestimmten Browsern unterstützt werden und sich in Zukunft ändern oder entfernt werden können. Unter Umständen kann sie jedoch eine geeignete Option sein, wenn es keine standardisierte Alternative gibt.

Der erste Satz der Seite muss diesem Format folgen:

Der HTTP header-name (Headertyp) wird für X in Y Umständen verwendet.

Der 'Headertyp' sollte angeben, ob es sich um einen Request-Header, einen Response-Header handelt, oder ob es sich um beide handeln kann. Der Zusammenfassungsabschnitt sollte idealerweise ein oder zwei kurze Sätze umfassen.

Sie können bemerkenswerte Fallen oder häufige Stolpersteine in diesem Abschnitt erwähnen, mit Links zu Beispielen oder detaillierteren Dokumentationen (Leitfäden, etc.) in diesem Abschnitt. Zwei oder drei Absätze in diesem Abschnitt sind angemessen, und wenn es wesentliche Nutzungshinweise gibt, verwenden Sie einen "Beschreibung"-Abschnitt nach den "Direktiven" unten.

Headertyp Fügen Sie die Headerkategorie (oder Kategorien) ein, z.B. Request-Header, Response-Header, Client-Hinweise
Verbotener Anforderungsheader "Ja" oder "Nein"
CORS-befreiter Antwortheader "Ja" oder "Nein"

Syntax

Füllen Sie ein Syntaxfeld aus, wie das untenstehende, gemäß den Richtlinien in unserem Artikel zu den Syntax-Abschnitten aus.

http
NameOfTheHeader: <directive1>
NameOfTheHeader: <directive1>, <directive2>, …

Wenn der Header viele verfügbare Direktiven hat, können Sie gerne mehrere Syntaxfelder, Unterabschnitte und Erklärungen je nach Bedarf einfügen:

http
NameOfTheHeader: <directive3>, …, <directiveN>

Die Direktiven sind nicht groß- und kleinschreibungssensitiv und haben ein optionales Argument, das sowohl Token- als auch Anführungszeichen-Syntax verwenden kann. Mehrere Direktiven werden durch Kommas getrennt (löschen Sie Informationen, je nach Bedarf).

Direktiven

directive1

Fügen Sie hier eine kurze Beschreibung der Direktive und ihrer Funktion hinzu. Fügen Sie für jedes Direktive einen Begriff und eine Definition ein.

directive2

etc.

Wenn der Header viele verfügbare Direktiven hat, können Sie gerne mehrere Definitionslisten, Unterabschnitte und Erklärungen je nach Bedarf einfügen.

Beschreibung

Wenn es zu viel Inhalt gibt, um ihn in die einleitenden Absätze aufzunehmen, geben Sie hier so viele Details wie nötig an, wie Hintergrundinformationen, Hinweise zur Nutzung und Links zur Dokumentation. Hier ist auch ein guter Platz, um darauf hinzuweisen, ob reale Muster von den spezifizierten abweichen, wenn weit verbreitete Implementierungen von dem abweichen, was in den Spezifikationen beschrieben ist.

Beispiele

Beachten Sie, dass wir den Plural "Beispiele" verwenden, auch wenn die Seite nur ein Beispiel enthält.

Eine beschreibende Überschrift

Jedes Beispiel muss eine H3-Überschrift (###) haben, die das Beispiel benennt. Die Überschrift sollte beschreiben, was das Beispiel tut. Zum Beispiel sagt "Ein einfaches Beispiel" nichts über das Beispiel aus und ist daher keine gute Überschrift. Die Überschrift sollte prägnant sein. Für eine längere Beschreibung verwenden Sie den Absatz nach der Überschrift.

Siehe unseren Leitfaden, wie man Codebeispiele einfügt für weitere Informationen.

Hinweis: Manchmal möchten Sie auf Beispiele verlinken, die auf einer anderen Seite gegeben werden.

Szenario 1: Wenn Sie einige Beispiele auf dieser Seite haben und einige weitere auf einer anderen Seite:

Fügen Sie eine H3-Überschrift (###) für jedes Beispiel auf dieser Seite ein und dann eine abschließende H3-Überschrift (###) mit dem Text "Weitere Beispiele", unter der Sie auf die Beispiele auf anderen Seiten verlinken können. Zum Beispiel:

md
## Beispiele

### Verwendung der Fetch-API

Beispiel der Fetch-Nutzung

### Weitere Beispiele

Links zu weiteren Beispielen auf anderen Seiten

Szenario 2: Wenn Sie nur Beispiele auf einer anderen Seite haben und keine auf dieser Seite:

Fügen Sie keine H3-Überschriften ein; fügen Sie nur die Links direkt unter der H2-Überschrift "Beispiele" ein. Zum Beispiel:

md
## Beispiele

Für Beispiele dieser API siehe [die Seite über fetch()](https://example.org/).

Spezifikationen

{{Specifications}}

Um dieses Makro zu verwenden, entfernen Sie die Backticks und den Schrägstrich im Markdown-Dokument.

Browser-Kompatibilität

Wenn der Browser keine spezifische Verarbeitung für den Header hat, entfernen Sie das folgende Makro. Andernfalls, um dieses Makro zu verwenden, entfernen Sie die Backticks und den Schrägstrich im Markdown-Dokument.

{{Compat}}

Wenn der Browser spezifische Verarbeitung für den Header hat, entfernen Sie den untenstehenden Text:

Dieser Header hat keine spezifikationsdefinierte Benutzeragent-Integration ("Browser-Kompatibilität" gilt nicht). Entwickler können HTTP-Header mit fetch() setzen und abrufen, um anwendungsspezifisches Implementierungsverhalten bereitzustellen.

Siehe auch

Fügen Sie Links zu Referenzseiten und Leitfäden hinzu, die sich auf den aktuellen HTTP-Header beziehen. Für weitere Richtlinien siehe den Siehe auch Abschnitt im Schreibstil-Leitfaden. Sie können auf relevante Antwortstatus wie {{HTTPStatus("123", "123 Reason")}} und Header wie {{HTTPHeader("Header-Name")}} verweisen. Sie können verwandte Status und Header in einem einzigen Listeneintrag zur Kürze gruppieren.

  • link1
  • link2
  • external_link (year)

Help improve MDN

Learn how to contribute Diese Seite wurde automatisch aus dem Englischen übersetzt.
Übersetzung auf GitHub anzeigen • Fehler mit dieser Übersetzung melden