API-Referenzseite Vorlage

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

Seiten-Frontmatter:

Das Frontmatter oben auf der Seite wird verwendet, um "Seiten-Metadaten" zu definieren. Die Werte sollten entsprechend für das jeweilige Attribut 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: Überschrift, die oben auf der Seite angezeigt wird. Dies ist nur der Name der Schnittstelle. Zum Beispiel hat die Seite der Request Schnittstelle einen title von Request.
slug: Das Ende des URL-Pfads nach https://developer.mozilla.org/de/docs/). Dies wird formatiert wie Web/API/NameOfTheParentInterface. Zum Beispiel ist der Slug von Request „Web/API/Request“.
page-type: Der page-type Schlüssel für Web/API-Schnittstellen ist immer web-api-interface.
status: Kennzeichnungen, die den Status dieser Funktion beschreiben. Ein Array, das einen oder mehrere der folgenden Werte 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 Funktionsstatus hinzugefügt oder aktualisiert werden“.
browser-compat: Ersetzen Sie den Platzhalterwert path.to.feature.NameOfTheMethod durch den Abfragestring für die Methode im Browser compat data repo. Die Toolchain verwendet diesen Schlüssel automatisch, um die Abschnitte Kompatibilität und Spezifikation zu füllen (Ersetzung der {{Compat}} und {{Specifications}} Makros).

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

Siehe unseren Leitfaden, wie dies zu tun ist.

Makros am Seitenanfang

Eine Anzahl von Makroaufrufen erscheint am oberen Rand des Inhaltsbereichs (direkt unter dem Seiten-Frontmatter).

Diese Makros werden automatisch von der Toolchain hinzugefügt (sie müssen nicht hinzugefügt/entfernt werden):

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

Sie sollten die folgenden Makros entsprechend den unten stehenden Hinweisen aktualisieren oder löschen:

{{SecureContext_Header}} — dies generiert ein Sicherer Kontext-Banner, das anzeigt, dass die Technologie nur in einem sicheren Kontext verfügbar ist. Wenn es nicht ist, können Sie den Makroaufruf entfernen. Wenn es ist, sollten Sie auch einen Eintrag dafür auf der Funktionen, die auf sichere Kontexte beschränkt sind Seite ausfüllen.
{{AvailableInWorkers}} — dies generiert eine Verfügbar in Workern-Notiz, die anzeigt, dass die Technologie im Arbeiterkontext verfügbar ist. Wenn es nur im Fensterkontext verfügbar ist, können Sie den Makroaufruf entfernen. Wenn es auch im Arbeiterkontext verfügbar oder nur dort verfügbar ist, müssen Sie möglicherweise einen Parameter aufgrund seiner Verfügbarkeit übergeben (siehe {{AvailableInWorkers}} Makros Quellcode für alle verfügbaren Werte), Sie müssen möglicherweise auch einen Eintrag dafür auf der Web APIs verfügbar in Workern Seite ausfüllen.
{{APIRef("GroupDataName")}} — dies generiert die linke Referenz-Seitenleiste, die schnelle Referenzlinks zeigt, die sich auf die aktuelle Seite beziehen. Zum Beispiel hat jede Seite in der WebVR API die gleiche Seitenleiste, die auf die anderen Seiten in der API verweist. Um die korrekte Seitenleiste 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 Leitfaden für API-Referenz-Seitenleisten für Informationen dazu.

Geben Sie keine Status-Header-Makros manuell an. Beziehen Sie sich auf den Abschnitt „Wie Funktionsstatus hinzugefügt oder aktualisiert werden“, um diese Status zur Seite hinzuzufügen.

Beispiele für die Sicherer Kontext, Verfügbar in Workern, Experimentell, Veraltet und Nicht-standard Banner werden direkt nach diesem Notizblock gezeigt.

Denken Sie daran, diese gesamte erklärende Notiz 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 mit der Benennung der Schnittstelle, geben Sie an, zu welcher API sie gehört, und was sie tut. Dies sollte idealerweise ein oder zwei kurze Sätze umfassen. Sie könnten den größten Teil hiervon aus der Zusammenfassung der Schnittstelle auf der entsprechenden API-Startseite 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 Eltern-Schnittstelle, {{DOMxRef("NameOfParentInterface")}}. (Hinweis: Wenn die Schnittstelle nicht von einer anderen Schnittstelle erbt, entfernen Sie diese gesamte Zeile.)

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

{{DOMxRef("NameOfTheInterface.staticProperty1")}} Schreibgeschützt Experimentell Veraltet Nicht standardisiert: Fügen Sie hier eine kurze Beschreibung der Eigenschaft und ihrer Funktion ein. Wenn die Eigenschaft nicht readonly/experimentell/veraltet/nicht-standard ist, entfernen Sie die entsprechenden Makroaufrufe.
{{DOMxRef("NameOfTheInterface.staticProperty2")}}: Fügen Sie hier eine kurze Beschreibung der Eigenschaft und ihrer Funktion ein. Wenn die Eigenschaft nicht readonly/experimentell/veraltet/nicht-standard ist, entfernen Sie die entsprechenden Makroaufrufe.

Instanz-Eigenschaften

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

{{DOMxRef("NameOfTheInterface.property1")}} Schreibgeschützt Experimentell Veraltet Nicht standardisiert: Fügen Sie hier eine kurze Beschreibung der Eigenschaft und ihrer Funktion ein. Wenn die Eigenschaft nicht readonly/experimentell/veraltet/nicht-standard ist, entfernen Sie die entsprechenden Makroaufrufe.
{{DOMxRef("NameOfTheInterface.property2")}}: Fügen Sie hier eine kurze Beschreibung der Eigenschaft und ihrer Funktion ein. Wenn die Eigenschaft nicht readonly/experimentell/veraltet/nicht-standard ist, entfernen Sie die entsprechenden Makroaufrufe.

Statische Methoden

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

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

{{DOMxRef("NameOfTheInterface.staticMethod1()")}} Experimentell Veraltet Nicht standardisiert: Fügen Sie hier eine kurze Beschreibung der Methode und ihrer Funktion ein. Wenn die Methode nicht experimentell/veraltet/nicht-standard ist, entfernen Sie die entsprechenden Makroaufrufe.
{{DOMxRef("NameOfTheInterface.staticMethod2()")}}: Fügen Sie hier eine kurze Beschreibung der Methode und ihrer Funktion ein. Wenn die Methode nicht experimentell/veraltet/nicht-standard ist, entfernen Sie die entsprechenden Makroaufrufe.

Instanz-Methoden

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

{{DOMxRef("NameOfTheInterface.method1()")}} Experimentell Veraltet Nicht standardisiert: Fügen Sie hier eine kurze Beschreibung der Methode und ihrer Funktion ein. Wenn die Methode nicht experimentell/veraltet/nicht-standard ist, entfernen Sie die entsprechenden Makroaufrufe.
{{DOMxRef("NameOfTheInterface.method2()")}}: Fügen Sie hier eine kurze Beschreibung der Methode und ihrer Funktion ein. Wenn die Methode nicht experimentell/veraltet/nicht-standard ist, entfernen Sie die entsprechenden Makroaufrufe.

Ereignisse

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

Hören Sie diese Ereignisse mit addEventListener() oder durch Zuordnen eines Ereignislisteners zur oneventname Eigenschaft dieser Schnittstelle.

{{DOMxRef("NameOfTheInterface.event1", "event1")}} Experimentell Veraltet Nicht standardisiert: Wird ausgelöst, wenn (Beschreibung hinzufügen, wann das Ereignis ausgelöst wird). Auch verfügbar über die oneventname1 Eigenschaft. Wenn das Ereignis nicht experimentell/veraltet/nicht-standard ist, entfernen Sie die entsprechenden Makroaufrufe.
{{DOMxRef("NameOfTheInterface.event2", "event2")}}: Wird ausgelöst, wenn (Beschreibung hinzufügen, wann das Ereignis ausgelöst wird). Auch verfügbar über die oneventname2 Eigenschaft. Wenn das Ereignis nicht experimentell/veraltet/nicht-standard ist, entfernen Sie die entsprechenden 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 benennt. 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 Codebeispiele hinzufügt für mehr Informationen.

Hinweis: Manchmal möchten Sie auf Beispiele auf einer anderen Seite verlinken.

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

Fügen Sie für jedes Beispiel auf dieser Seite eine H3-Überschrift (###) hinzu 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:

## 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 über fetch()](https://example.org/).

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