Modèle de sous-page de référence d'API

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'interface particulière.

---
title: NameOfTheInterface
slug: Web/API/NameOfTheInterface
page-type: web-api-interface
status:
  - deprecated
  - experimental
  - non-standard
browser-compat: path.to.feature.NameOfTheInterface
---

title: Titre affiché en haut de la page. Il s'agit simplement du nom de l'interface. Par exemple, la page de l'interface Request a un titre de Request.
slug: La fin du chemin de l'URL après https://developer.mozilla.org/fr/docs/. C'est formaté comme Web/API/NameOfTheParentInterface. Par exemple, le slug de Request est Web/API/Request.
page-type: La clé page-type pour les interfaces Web/API est toujours web-api-interface.
status: Indique l'état de cette fonctionnalité. Il s'agit d'un tableau pouvant 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: Remplacez la valeur de l'espace réservé path.to.feature.NameOfTheMethod par la chaîne de requête pour la méthode dans le dépôt de données de compatibilité des navigateurs ^(angl.). La chaîne d'outils utilise automatiquement la clé pour remplir les sections de compatibilité et de spécification (en remplaçant les macros {{Compat}} et {{Specifications}}).

Notez que vous devez d'abord créer/met à jour une entrée pour la méthode API dans notre dépôt de données de compatibilité des navigateurs ^(angl.), et l'entrée pour l'API doit inclure des informations sur la spécification.

Consultez notre guide sur la façon de procéder.

Macros en haut de page

Un certain nombre d'appels de macros apparaissent en haut de la section de contenu (immédiatement sous les métadonnées de la page).

Ces macros sont ajoutées automatiquement par la chaîne d'outils (il n'est pas nécessaire de les ajouter/supprimer) :

{{SeeCompatTable}} — cela génère une bannière Ceci est une technologie expérimentale qui indique que la technologie est expérimentale. 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 la technologie est obsolète.
{{Non-standard_Header}} — cela génère une bannière Non standard qui indique que la fonctionnalité ne fait partie d'aucune spécification.

Vous devez mettre à jour ou supprimer les macros suivantes selon les conseils ci-dessous :

{{SecureContext_Header}} — cela génère une bannière Contexte sécurisé qui indique que la technologie n'est disponible que dans un contexte sécurisé. Si ce n'est pas le cas, vous pouvez supprimer l'appel de macro. Si c'est le cas, vous devez également remplir une entrée pour elle dans la page Fonctionnalités restreintes aux contextes sécurisés.
{{AvailableInWorkers}} — cela génère une note Disponible dans les workers qui indique que la technologie est disponible dans un contexte worker. Si elle n'est disponible que dans le contexte window, vous pouvez supprimer l'appel de macro. Si elle est également disponible ou uniquement disponible dans le contexte worker, vous devez passer un paramètre en raison de sa disponibilité (voir le code source des macros {{AvailableInWorkers}} ^(angl.) pour toutes les valeurs disponibles), vous devez également remplir une entrée pour elle dans la page API Web disponibles dans les workers.
{{APIRef("GroupDataName")}} — cela génère la barre latérale de référence à gauche affichant des liens de référence rapide liés à la page actuelle. Par exemple, chaque page de l'API WebVR a la même barre latérale, qui pointe vers les autres pages de l'API. Pour générer la barre latérale correcte pour votre API, vous devez ajouter une entrée GroupData et inclure le nom de l'entrée dans l'appel de macro à la place de GroupDataName. Consultez notre guide sur les barres latérales de référence API pour plus d'informations.

Ne fournissez pas manuellement les macros d'en-tête de statut. Reportez-vous à 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 Contexte sécurisé, Disponible dans les workers, Expérimental, 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.

Contexte sécurisé: Cette fonctionnalité est uniquement disponible dans des contextes sécurisés (HTTPS), pour certains navigateurs qui la prennent en charge.

Note : Cette fonctionnalité est disponible via les Web Workers.

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.

Le paragraphe de résumé — commencez par nommer l'interface, en indiquant à quelle API elle appartient et ce qu'elle fait. Idéalement, cela doit être une ou deux phrases courtes. Vous pouvez copier la plupart de ces informations à partir du résumé de l'interface sur la page de destination correspondante de l'API.

{{InheritanceDiagram}}

Pour utiliser la macro domxref dans les sections ci-dessous, supprimez les accents inversés et l'antislash dans le fichier markdown.

Constructeurs

{{DOMxRef("NameOfTheInterface.NameOfTheInterface", "NameOfTheInterface()")}}: Crée une nouvelle instance de l'objet NameOfTheInterface.

Propriétés statiques

Hérite également des propriétés de son interface parente, {{DOMxRef("NameOfParentInterface")}}. (Remarque : si l'interface n'hérite pas d'une autre interface, supprimez cette ligne entière.)

Incluez un terme et une définition pour chaque propriété.

{{DOMxRef("NameOfTheInterface.staticProperty1")}} Lecture seule: Incluez une brève description de la propriété et de ce qu'elle fait ici. Si la propriété n'est pas en lecture seule/expérimentale/obsolète/non standard, supprimez les appels de macro correspondants.
{{DOMxRef("NameOfTheInterface.staticProperty2")}}: Incluez une brève description de la propriété et de ce qu'elle fait ici. Si la propriété n'est pas en lecture seule/expérimentale/obsolète/non standard, supprimez les appels de macro correspondants.

Propriétés d'instance

Incluez un terme et une définition pour chaque propriété.

{{DOMxRef("NameOfTheInterface.property1")}} Lecture seule: Incluez une brève description de la propriété et de ce qu'elle fait ici. Si la propriété n'est pas en lecture seule/expérimentale/obsolète/non standard, supprimez les appels de macro correspondants.
{{DOMxRef("NameOfTheInterface.property2")}}: Incluez une brève description de la propriété et de ce qu'elle fait ici. Si la propriété n'est pas en lecture seule/expérimentale/obsolète/non standard, supprimez les appels de macro correspondants.

Méthodes statiques

Hérite également des méthodes de son interface parente, {{DOMxRef("NameOfParentInterface")}}. (Remarque : si l'interface n'hérite pas d'une autre interface, supprimez cette ligne entière.)

Incluez un terme et une définition pour chaque méthode.

{{DOMxRef("NameOfTheInterface.staticMethod1()")}}: Incluez une brève description de la méthode et de ce qu'elle fait ici. Si la méthode n'est pas expérimentale/obsolète/non standard, supprimez les appels de macro correspondants.
{{DOMxRef("NameOfTheInterface.staticMethod2()")}}: Incluez une brève description de la méthode et de ce qu'elle fait ici. Si la méthode n'est pas expérimentale/obsolète/non standard, supprimez les appels de macro correspondants.

Méthodes d'instance

Hérite également des méthodes de son interface parente, {{DOMxRef("NameOfParentInterface")}}. (Remarque : si l'interface n'hérite pas d'une autre interface, supprimez cette ligne entière.)

Incluez un terme et une définition pour chaque méthode.

{{DOMxRef("NameOfTheInterface.method1()")}}: Incluez une brève description de la méthode et de ce qu'elle fait ici. Si la méthode n'est pas expérimentale/obsolète/non standard, supprimez les appels de macro correspondants.
{{DOMxRef("NameOfTheInterface.method2()")}}: Incluez une brève description de la méthode et de ce qu'elle fait ici. Si la méthode n'est pas expérimentale/obsolète/non standard, supprimez les appels de macro correspondants.

Évènements

Hérite également des évènements de son interface parente, {{DOMxRef("NameOfParentInterface")}}. (Remarque : si l'interface n'hérite pas d'une autre interface, supprimez cette ligne entière.)

Écoutez ces évènements en utilisant addEventListener() ou en assignant un écouteur d'évènements à la propriété oneventname de cette interface.

{{DOMxRef("NameOfTheInterface.event1", "event1")}}: Déclenché lorsque (incluez la description de l'évènement). Disponible également avec la propriété oneventname1. Si l'évènement n'est pas expérimental/obsolète/non standard, supprimez les appels de macro correspondants.
{{DOMxRef("NameOfTheInterface.event2", "event2")}}: Déclenché lorsque (incluez la description de l'évènement). Disponible également avec la propriété oneventname2. Si l'évènement n'est pas expérimental/obsolète/non standard, supprimez les appels de macro correspondants.

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 :

## 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 :

## Exemples

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

lien1
lien2
lien_externe (année)

Aider à améliorer MDN

Apprendre à contribuer

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

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