Vorlagen für API-Referenzseiten

Hinweis:>Entfernen Sie diese gesamte erklärende Anmerkung vor der Veröffentlichung.

Seitendaten:

Die Metadaten am Anfang der Seite werden verwendet, um "Seiten-Metadaten" zu definieren. Die Werte sollten für das jeweilige Merkmal entsprechend aktualisiert werden.

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

title: Titelüberschrift, die oben auf der Seite angezeigt wird. Dies ist nur der Name der Schnittstelle. Zum Beispiel hat die Seite der Schnittstelle Request einen Titel von Request.
slug: Der letzte Teil des URL-Pfads nach https://developer.mozilla.org/de/docs/). Dieser wird formatiert wie Web/API/NameOfTheParentInterface. Zum Beispiel hat Request den Slug "Web/API/Request".
page-type: Der Schlüssel page-type für Web/API-Schnittstellen ist immer web-api-interface.
status: Kennzeichnungen, die den Status dieses Merkmals 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 Werten in den Browser-Kompatibilitätsdaten für das Merkmal gesetzt. Siehe "Wie Feature-Status hinzugefügt oder aktualisiert werden".
browser-compat: Ersetzen Sie den Platzhalterwert path.to.feature.NameOfTheMethod mit der Abfragezeichenfolge für die Methode im Browser compat data repo. Die Toolchain verwendet den Schlüssel automatisch, um die Kompatibilitäts- und Spezifikationsabschnitte auszufüllen (ersetzen der {{Compat}} und {{Specifications}} Makros).

Beachten Sie, dass Sie möglicherweise zunächst einen Eintrag für die API-Methode in unserem Browser compat data repo erstellen/aktualisieren müssen, und dass der Eintrag für die API Spezifikationsinformationen enthalten muss.

Siehe unseren Leitfaden, wie man dies tut.

Makros am Seitenanfang

Eine Reihe von Makroaufrufen erscheint oben im Inhaltsbereich (direkt unter den Seitendaten).

Diese Makros werden automatisch von der Toolchain hinzugefügt (es besteht keine Notwendigkeit, sie hinzuzufügen/zu entfernen):

{{SeeCompatTable}} — dieses generiert ein Dies ist eine experimentelle Technologie Banner, das anzeigt, dass die Technologie experimentell ist. Wenn sie experimentell ist und die Technologie in Firefox hinter einem Pref versteckt ist, sollten Sie auch einen Eintrag dafür auf der Seite Experimentelle Funktionen in Firefox ausfüllen.
{{Deprecated_Header}} — dieses generiert ein Veraltet Banner, das anzeigt, dass die Technologie veraltet ist.
{{Non-standard_Header}} — dieses generiert ein Nicht-standard Banner, das anzeigt, dass das Merkmal nicht Teil einer Spezifikation ist.

Sie sollten die folgenden Makros gemäß den nachstehenden Ratschlägen aktualisieren oder löschen:

{{SecureContext_Header}} — dieses generiert ein Sicherer Kontext Banner, das anzeigt, dass die Technologie nur in einem sicheren Kontext verfügbar ist. Wenn dies nicht der Fall ist, können Sie den Makroaufruf entfernen. Wenn doch, sollten Sie auch einen Eintrag dafür auf der Seite Funktionen, die auf sichere Kontexte beschränkt sind ausfüllen.
{{AvailableInWorkers}} — dieses generiert eine Verfügbar in Arbeitern-Notiz, die anzeigt, dass die Technologie im Arbeiter-Kontext verfügbar ist. Wenn sie nur im Fenster-Kontext verfügbar ist, können Sie den Makroaufruf entfernen. Wenn sie auch im oder nur im Arbeiter-Kontext verfügbar ist, müssen Sie möglicherweise einen Parameter dafür übergeben, basierend auf ihrer Verfügbarkeit (siehe {{AvailableInWorkers}} Makros Quellcode für alle verfügbaren Werte), Sie müssen möglicherweise auch einen Eintrag dafür auf der Seite Web-APIs, die in Arbeitern verfügbar sind ausfüllen.
{{APIRef("GroupDataName")}} — dieses generiert die linke Referenz-Sidebar, die schnelle Referenzlinks anzeigt, die sich auf die aktuelle Seite beziehen. Zum Beispiel hat jede Seite in der WebVR API die gleiche Sidebar, die auf die anderen Seiten in der API verweist. Um die korrekte Sidebar für Ihre API zu generieren, müssen Sie einen GroupData-Eintrag hinzufügen und den Namen des Eintrags im Makroaufruf anstelle von GroupDataName einfügen. Siehe unseren API-Referenz-Sidebars Leitfaden für Informationen dazu, wie dies zu tun ist.

Statusheader-Makros sollten nicht manuell bereitgestellt werden. Informieren Sie sich im Abschnitt "Wie Feature-Status hinzugefügt oder aktualisiert werden", um diese Status der Seite hinzuzufügen.

Beispiele der Sicherer Kontext, Verfügbar in Arbeitern, Experimentell, Veraltet und Nicht-standard Banner werden direkt nach diesem Anmerkungsblock dargestellt.

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

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

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 zusammenfassende Absatz — beginnen Sie, indem Sie die Schnittstelle benennen, sagen, zu welcher API sie gehört, und was sie tut. Dies sollte idealerweise ein oder zwei kurze Sätze sein. Sie könnten den größten Teil davon aus der Zusammenfassung der Schnittstelle auf der entsprechenden API-Übersichtsseite kopieren.

{{InheritanceDiagram}}

Um das domxref-Makro in den folgenden Abschnitten zu verwenden, entfernen Sie die Backticks und den Backslash in der Markdown-Datei.

Konstruktor

{{DOMxRef("NameOfTheInterface.NameOfTheInterface", "NameOfTheInterface()")}}: Erstellt eine neue Instanz des NameOfTheInterface Objekts.

Statische Eigenschaften

Erbt auch Eigenschaften von seiner Elternschnittstelle, {{DOMxRef("NameOfParentInterface")}}. (Hinweis: Wenn die Schnittstelle nicht von einer anderen Schnittstelle erbt, entfernen Sie diese gesamte Zeile.)

Fügen Sie für jede Eigenschaft einen Begriff und eine Definition hinzu.

{{DOMxRef("NameOfTheInterface.staticProperty1")}} Schreibgeschützt Experimentell Veraltet Nicht standardisiert: Fügen Sie hier eine kurze Beschreibung der Eigenschaft und ihrer Funktionen hinzu. Wenn die Eigenschaft nicht schreibgeschützt/experimentell/veraltet/nicht standardisiert ist, entfernen Sie die zugehörigen Makroaufrufe.
{{DOMxRef("NameOfTheInterface.staticProperty2")}}: Fügen Sie hier eine kurze Beschreibung der Eigenschaft und ihrer Funktionen hinzu. Wenn die Eigenschaft nicht schreibgeschützt/experimentell/veraltet/nicht standardisiert ist, entfernen Sie die zugehörigen Makroaufrufe.

Instanz-Eigenschaften

Fügen Sie für jede Eigenschaft einen Begriff und eine Definition hinzu.

{{DOMxRef("NameOfTheInterface.property1")}} Schreibgeschützt Experimentell Veraltet Nicht standardisiert: Fügen Sie hier eine kurze Beschreibung der Eigenschaft und ihrer Funktionen hinzu. Wenn die Eigenschaft nicht schreibgeschützt/experimentell/veraltet/nicht standardisiert ist, entfernen Sie die zugehörigen Makroaufrufe.
{{DOMxRef("NameOfTheInterface.property2")}}: Fügen Sie hier eine kurze Beschreibung der Eigenschaft und ihrer Funktionen hinzu. Wenn die Eigenschaft nicht schreibgeschützt/experimentell/veraltet/nicht standardisiert ist, entfernen Sie die zugehörigen Makroaufrufe.

Statische Methoden

Erbt auch Methoden von seiner Elternschnittstelle, {{DOMxRef("NameOfParentInterface")}}. (Hinweis: Wenn die Schnittstelle nicht von einer anderen Schnittstelle erbt, entfernen Sie diese gesamte Zeile.)

Fügen Sie für jede Methode einen Begriff und eine Definition hinzu.

{{DOMxRef("NameOfTheInterface.staticMethod1()")}} Experimentell Veraltet Nicht standardisiert: Fügen Sie hier eine kurze Beschreibung der Methode und ihrer Funktionen hinzu. Wenn die Methode nicht experimentell/veraltet/nicht standardisiert ist, entfernen Sie die zugehörigen Makroaufrufe.
{{DOMxRef("NameOfTheInterface.staticMethod2()")}}: Fügen Sie hier eine kurze Beschreibung der Methode und ihrer Funktionen hinzu. Wenn die Methode nicht experimentell/veraltet/nicht standardisiert ist, entfernen Sie die zugehörigen Makroaufrufe.

Instanz-Methoden

Fügen Sie für jede Methode einen Begriff und eine Definition hinzu.

{{DOMxRef("NameOfTheInterface.method1()")}} Experimentell Veraltet Nicht standardisiert: Fügen Sie hier eine kurze Beschreibung der Methode und ihrer Funktionen hinzu. Wenn die Methode nicht experimentell/veraltet/nicht standardisiert ist, entfernen Sie die zugehörigen Makroaufrufe.
{{DOMxRef("NameOfTheInterface.method2()")}}: Fügen Sie hier eine kurze Beschreibung der Methode und ihrer Funktionen hinzu. Wenn die Methode nicht experimentell/veraltet/nicht standardisiert ist, entfernen Sie die zugehörigen Makroaufrufe.

Events

Erbt auch Events von seiner Elternschnittstelle, {{DOMxRef("NameOfParentInterface")}}. (Hinweis: Wenn die Schnittstelle nicht von einer anderen Schnittstelle erbt, entfernen Sie diese gesamte Zeile.)

Hören Sie auf diese Events, indem Sie addEventListener() verwenden oder einen Event-Listener der oneventname-Eigenschaft dieser Schnittstelle zuweisen.

{{DOMxRef("NameOfTheInterface.event1", "event1")}} Experimentell Veraltet Nicht standardisiert: Wird ausgelöst, wenn (Beschreibung des Ereignisses einfügen). Ebenfalls verfügbar über die oneventname1 Eigenschaft. Wenn das Event nicht experimentell/veraltet/nicht standardisiert ist, entfernen Sie die zugehörigen Makroaufrufe.
{{DOMxRef("NameOfTheInterface.event2", "event2")}}: Wird ausgelöst, wenn (Beschreibung des Ereignisses einfügen). Ebenfalls verfügbar über die oneventname2 Eigenschaft. Wenn das Event nicht experimentell/veraltet/nicht standardisiert ist, entfernen Sie die zugehörigen Makroaufrufe.

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 bezeichnet. Die Überschrift sollte beschreiben, was das Beispiel macht. 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 Code-Beispiele hinzufügt für mehr Informationen.

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

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

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

## Beispiele

### Verwendung der Fetch-API

Beispiel von Fetch

### 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 hinzu; fügen Sie die Links direkt unter der H2-Überschrift "Beispiele" hinzu. Zum Beispiel:

## Beispiele

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

link1
link2
external_link (year)