Vorlagenseite für API-Referenz

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

Seiten-Metadaten:

Die Metadaten am Anfang der Seite werden verwendet, um "Seitenmetadaten" zu definieren. Die Werte sollten entsprechend der spezifischen Eigenschaft aktualisiert werden.

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

title: Titelüberschrift, die oben auf der Seite angezeigt wird. Dies ist nur der Name der Schnittstelle. Zum Beispiel hat die Schnittstellenseite Request einen title von Request.
slug: Das Ende des URL-Pfads nach https://developer.mozilla.org/de/docs/). Dies wird im Format Web/API/NameDerÜbergeordnetenSchnittstelle sein. Zum Beispiel ist der Request slug "Web/API/Request".
page-type: Der page-type Schlüssel für Web/API-Schnittstellen ist immer web-api-interface.
status: Flags, die den Status dieser Funktion beschreiben. Ein Array, welches 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 die Funktion gesetzt. Siehe "Anleitung zum Hinzufügen oder Aktualisieren von Funktionsstatus".
browser-compat: Ersetzen Sie den Platzhalterwert path.to.feature.NameOfTheMethod durch den Abfrage-String für die Methode im Browser compat data repo. Die Werkzeugkette nutzt diesen Schlüssel automatisch, um die Kompatibilitäts- und Spezifikationsabschnitte zu füllen (ersetzt die {{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 Sie dies tun können.

Makros am Seitenanfang

Eine Reihe von Makroaufrufen erscheinen am Beginn des Inhaltsabschnitts (unmittelbar unter den Seiten-Metadaten).

Diese Makros werden automatisch durch die Werkzeugkette hinzugefügt (es ist nicht notwendig, sie hinzu zu fügen/entfernen):

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

Sie sollten die folgenden Makros gemäß der nachfolgenden Anweisung aktualisieren oder löschen:

{{SecureContext_Header}} — generiert ein Sicherer Kontext Banner, das anzeigt, dass die Technologie nur in einem sicheren Kontext verfügbar ist. Falls nicht, können Sie den Makroaufruf entfernen. Wenn doch, sollten Sie auch einen Eintrag auf der Seite Features eingeschränkt auf sichere Kontexte ausfüllen.
{{AvailableInWorkers}} — generiert eine Verfügbar in Arbeitern Notiz, die anzeigt, dass die Technologie im Arbeiterkontext verfügbar ist. Falls nur im Fensterkontext verfügbar, können Sie den Makroaufruf entfernen. Falls auch oder nur im Arbeiterkontext verfügbar, müssen Sie möglicherweise einen Parameter aufgrund der Verfügbarkeit übergeben (siehe {{AvailableInWorkers}} Makro-Quellcode für alle verfügbaren Werte) und auch einen Eintrag auf der Seite Web-APIs verfügbar in Arbeitern ausfüllen.
{{APIRef("GroupDataName")}} — generiert die linke Referenz-Sidebar, die schnelle Referenzlinks zeigt, die mit der aktuellen Seite zu tun haben. Zum Beispiel hat jede Seite der WebVR API die gleiche Sidebar, die auf die anderen Seiten der API verweist. Um die korrekte Sidebar für Ihre API zu generieren, müssen Sie einen GroupData Eintrag in unserem KumaScript GitHub Repo hinzufügen und den Namen des Eintrags in den Makroaufruf anstelle von GroupDataName einfügen. Siehe unseren Leitfaden zur Erstellung von API-Referenz-Sidebars für weitere Informationen.

Fügen Sie keine Status-Header-Makros manuell hinzu. Beziehen Sie sich auf den Abschnitt "Anleitung zum Hinzufügen oder Aktualisieren von Funktionsstatus", um diese Status der Seite hinzuzufügen.

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

Denken Sie daran, diesen gesamten erläuternden Hinweis 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: Dieses Feature ist verfügbar in Web Workers.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig, bevor Sie diese produktiv verwenden.

Veraltet: Diese Funktion wird nicht mehr empfohlen. Obwohl einige Browser sie möglicherweise noch unterstützen, kann sie bereits aus den relevanten Webstandards entfernt worden sein, befindet sich im Prozess der Entfernung oder wird nur aus Kompatibilitätsgründen beibehalten. Vermeiden Sie die Verwendung und aktualisieren Sie gegebenenfalls bestehenden Code; siehe die Kompatibilitätstabelle am Ende dieser Seite, um Ihre Entscheidung zu treffen. Beachten Sie, dass diese Funktion jederzeit nicht mehr funktionieren kann.

Kein Standard: Diese Funktion ist nicht standardisiert und befindet sich nicht im Standardisierungsprozess. Verwenden Sie sie nicht auf Produktionsseiten, die auf das Web ausgerichtet sind: Sie wird nicht für alle Benutzer funktionieren. Außerdem kann es große Inkompatibilitäten zwischen Implementierungen geben und das Verhalten kann sich in Zukunft ändern.

Der Zusammenfassungs-Absatz — beginnen Sie mit dem Benennen der Schnittstelle, sagen Sie, 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 dieser Information aus der Zusammenfassung der Schnittstelle auf der entsprechenden API-Landingpage kopieren.

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 Objekts NameOfTheInterface.

Statische Eigenschaften

Erbt auch Eigenschaften von seiner übergeordneten Schnittstelle, {{DOMxRef("NameOfParentInterface")}}. (Hinweis: Falls 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 ein.

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

Instanz-Eigenschaften

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

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

Statische Methoden

Erbt auch Methoden von seiner übergeordneten Schnittstelle, {{DOMxRef("NameOfParentInterface")}}. (Hinweis: Falls 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 ein.

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

Instanz-Methoden

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

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

Ereignisse

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

Hören Sie diese Ereignisse mit addEventListener() oder indem Sie einen Event-Listener der oneventname Eigenschaft dieser Schnittstelle zuweisen.

{{DOMxRef("NameOfTheInterface.event1", "event1")}} Experimentell Veraltet Nicht standardisiert: Ausgelöst, wenn (fügen Sie die Beschreibung ein, wann das Ereignis ausgelöst wird). Auch verfügbar über die oneventname1 Eigenschaft. Wenn das Ereignis nicht experimentell/veraltet/nicht standardisiert ist, entfernen Sie die entsprechenden Makroaufrufe.
{{DOMxRef("NameOfTheInterface.event2", "event2")}}: Ausgelöst, wenn (fügen Sie die Beschreibung ein, wann das Ereignis ausgelöst wird). Auch verfügbar über die oneventname2 Eigenschaft. Wenn das Ereignis nicht experimentell/veraltet/nicht standardisiert ist, entfernen Sie die entsprechenden Makroaufrufe.

Beispiele

Beachten Sie, dass wir den Plural "Beispiele" verwenden, selbst 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. Beispielsweise 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 zum Hinzufügen von Code-Beispielen für weitere Informationen.

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

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

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

## 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 und keine auf dieser Seite haben:

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

## Beispiele

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

link1
link2
external_link (year)