1. MDN Web Docs
  2. Règles d'écriture
  3. Structures des documents
  4. Types de pages
  5. Modèle de page d'en-tête HTTP

Cette page a été traduite à partir de l'anglais par la communauté. Vous pouvez contribuer en rejoignant la communauté francophone sur MDN Web Docs.

View in English Always switch to English

Modèle de page d'en-tête HTTP

Note : Supprimez cette note explicative avant de publier.

Page de garde :

Les métadonnées en haut de la page sont utilisées pour définir les « métadonnées de la page ». Les valeurs doivent être mises à jour de manière appropriée pour l'attribut particulier.

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

Titre affiché en haut de la page. Formaté comme En-tête NomDeLen-tête. Par exemple, l'en-tête Cache-Control a un titre de En-tête Cache-Control.

short-title

Un titre court utilisé dans les fil d'Ariane et les barres latérales. Formaté comme NomDeLen-tête. Par exemple, l'en-tête Cache-Control a un titre court de Cache-Control.

slug

La fin du chemin URL après https://developer.mozilla.org/fr/docs/. C'est formaté comme Web/HTTP/Reference/Headers/NomDeLen-tête. Par exemple, l'en-tête Cache-Control a un chemin de Web/HTTP/Reference/Headers/Cache-Control.

page-type (pages anglaises uniquement)

Pour les en-têtes HTTP, doit être http-header. Pour d'autres valeurs de page-type HTTP, voir la section HTTP de la documentation pour la clé de page de garde page-type.

status (pages anglaises uniquement)

Indique l'état de cette fonctionnalité. Un tableau qui peut contenir une ou plusieurs des valeurs suivantes : experimental, deprecated, non-standard. Cette clé ne doit pas être définie manuellement : elle est définie automatiquement en fonction des valeurs dans les données de compatibilité des navigateurs pour la fonctionnalité. Voir « Comment les statuts des fonctionnalités sont ajoutés ou mis à jour ».

browser-compat (pages anglaises uniquement)

Remplacez la valeur de l'espace réservé path.to.feature.NameOfTheHeader par la chaîne de requête pour l'en-tête dans le dépôt de données de compatibilité des navigateurs (angl.). La chaîne d'outils utilise automatiquement la clé pour remplir la section de compatibilité (en remplaçant la macro {{Compat}}).

Notez que vous devez d'abord créer ou mettre à jour une entrée pour l'en-tête HTTP dans notre dépôt de données de compatibilité des navigateurs (angl.), et l'entrée pour l'en-tête doit inclure des informations sur la spécification. Consultez notre guide sur la façon de procéder.

La compatibilité des navigateurs ne s'applique pas aux en-têtes HTTP pour lesquels aucune implémentation spécifique n'est fournie (comme l'ajout automatique d'un en-tête de requête à certaines requêtes ou la modification du comportement en fonction des données d'un en-tête de réponse). Dans ces cas, supprimez la clé et la valeur browser-compat.

Conservez toujours http. Voir Structures de page : Barres latérales pour plus de détails.

Macros en haut de page

Un certain nombre de macros apparaissent en haut de la section de contenu immédiatement après les métadonnées de la page. Ces macros sont ajoutées automatiquement par la chaîne d'outils, il est donc recommandé de ne pas les ajouter ou les supprimer.

  • {{SeeCompatTable}} — cela génère une bannière Ceci est une technologie expérimentale qui indique que l'en-tête est expérimental. Si elle est expérimentale et que la technologie est cachée derrière une préférence dans Firefox, vous devez également remplir une entrée pour elle dans la page Fonctionnalités expérimentales dans Firefox.
  • {{Deprecated_Header}} — cela génère une bannière Obsolète qui indique que l'utilisation de l'en-tête est découragée.
  • {{Non-standard_Header}} — cela génère une bannière Non standard qui indique que la fonctionnalité ne fait partie d'aucune spécification.

Ne fournissez pas manuellement les macros de statut des en-têtes. Consultez la section « Comment les statuts des fonctionnalités sont ajoutés ou mis à jour » pour ajouter ces statuts à la page.

Des exemples des bannières Expérimentale, Obsolète et Non standard sont présentés juste après ce bloc de notes.

N'oubliez pas de supprimer cette note explicative avant de publier.

Expérimental: Il s'agit d'une technologie expérimentale.
Vérifiez attentivement le tableau de compatibilité des navigateurs avant de l'utiliser en production.

Obsolète: Cette fonctionnalité n'est plus recommandée. Même si certains navigateurs la prennent encore en charge, elle a peut-être déjà été supprimée des standards du web, est en passe d'être supprimée ou n'est conservée qu'à des fins de compatibilité. Évitez de l'utiliser et mettez à jour le code existant si possible ; consultez le tableau de compatibilité au bas de cette page pour vous aider à prendre votre décision. Sachez que cette fonctionnalité peut cesser de fonctionner à tout moment.

Non standard: Cette fonctionnalité n'est pas standardisée. Nous déconseillons d'utiliser des fonctionnalités non standard en production, car leur prise en charge par les navigateurs est limitée, et elles peuvent être modifiées ou supprimées. Toutefois, elles peuvent constituer une alternative appropriée dans certains cas où aucune option standard n'existe.

La première phrase de la page doit suivre ce format :

Le (type d'en-tête) HTTP header-name est utilisé pour X dans les circonstances Y.

Le « type d'en-tête » doit indiquer s'il s'agit d'un en-tête de requête, d'un en-tête de réponse, ou s'il peut être l'un ou l'autre. Le paragraphe de résumé doit idéalement être composé d'une ou deux phrases courtes.

Vous pouvez mentionner des pièges notables ou des erreurs courantes dans cette section, en créant des liens vers des exemples ou une documentation plus détaillée (guides, etc.) dans cette section. Deux ou trois paragraphes dans cette section sont appropriés, et s'il y a des notes d'utilisation substantielles à inclure, utilisez une section "Description" après "Directives" ci-dessous.

Type d'en-tête Inclure la catégorie (ou les catégories) de l'en-tête, par exemple En-tête de requête, En-tête de réponse, Indice client
En-tête de requête interdit « Oui » ou « Non »
En-tête de réponse CORS autorisé « Oui » ou « Non »

Syntaxe

Remplissez une boîte de syntaxe, comme celle ci-dessous, conformément aux directives de notre article sur les sections de syntaxe.

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

Si l'en-tête dispose de nombreuses directives disponibles, n'hésitez pas à inclure plusieurs boîtes de syntaxe, sous-sections et explications selon les besoins :

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

Les directives ne sont pas sensibles à la casse et peuvent avoir un argument optionnel, qui peut utiliser à la fois la syntaxe token et la syntaxe quoted-string. Les directives multiples sont séparées par des virgules (supprimez les informations si nécessaire).

Directives

directive1

Inclure une brève description de la directive et de ce qu'elle fait ici. Inclure un terme et une définition pour chaque directive.

directive2

etc.

Si l'en-tête dispose de nombreuses directives disponibles, n'hésitez pas à inclure plusieurs listes de définitions, sous-sections et explications selon les besoins.

Description

Si le contenu est trop volumineux pour être inclus dans les paragraphes d'ouverture, fournissez autant de détails que nécessaire ici, tels que des informations contextuelles, des conseils d'utilisation et des liens vers la documentation. C'est un bon endroit pour noter si les modèles réels diffèrent de ce qui est défini si les implémentations largement déployées s'écartent de ce qui est décrit dans les spécifications.

Exemples

Notez que nous utilisons le pluriel « Exemples » même si la page ne contient qu'un seul exemple.

Un titre descriptif

Chaque exemple doit avoir un titre H3 nommant l'exemple. Le titre doit être descriptif de ce que fait l'exemple. Par exemple, « Un exemple simple » ne dit rien sur l'exemple et n'est donc pas un bon titre. Le titre doit être concis. Pour une description plus longue, utilisez le paragraphe après le titre.

Consultez notre guide sur la façon d'ajouter des exemples de code pour plus d'informations.

Note : Parfois, vous pouvez vouloir créer un lien vers des exemples donnés sur une autre page.

Scénario 1 : Si vous avez des exemples sur cette page et d'autres exemples sur une autre page :

Incluez un titre H3 (###) pour chaque exemple sur cette page, puis un dernier titre H3 (###) avec le texte « Plus d'exemples », sous lequel vous pouvez créer des liens vers les exemples sur d'autres pages. Par exemple :

md
## Exemples

### Utiliser l'API fetch

Exemple de Fetch

### Plus d'exemples

Liens vers plus d'exemples sur d'autres pages

Scénario 2 : Si vous n'avez des exemples que sur une autre page et aucun sur cette page :

N'ajoutez pas de titres H3 ; ajoutez simplement les liens directement sous le titre H2 « Exemples ». Par exemple :

md
## Exemples

Pour des exemples de cette API, voir [la page sur `fetch()`](https://example.org/).

Spécifications

{{Specifications}}

Pour utiliser cette macro, supprimez les accents inversés et l'antislash dans le fichier markdown.

Compatibilité des navigateurs

{{Compat}}

Pour utiliser cette macro, supprimez les accents inversés et l'antislash dans le fichier markdown.

Voir aussi

Incluez des liens vers des pages de référence et des guides liés à l'API actuelle. Pour plus de directives, consultez la section Voir aussi dans le Guide de style d'écriture.

  • lien1
  • lien2
  • lien_externe (année)

Aider à améliorer MDN

Apprendre à contribuer

Cette page a été modifiée le par les contributeur·ice·s du MDN.

Voir cette page sur GitHub • Signaler un problème avec ce contenu