API-Referenz seitenseite Vorlage
Hinweis: Entfernen Sie diese gesamte erläuternde Notiz vor der Veröffentlichung.
Seiten-Metadaten:
Die Metadaten am Anfang der Seite werden verwendet, um "Seiten-Metadaten" zu definieren. Die Werte sollten entsprechend für die jeweilige Eigenschaft 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 Request Schnittstellenseite einen title von Request.
- slug
-
Das Ende des URL-Pfads nach
https://developer.mozilla.org/de/docs/). Dies wird wieWeb/API/NameOfTheParentInterfaceformatiert. Zum Beispiel ist der Request slug "Web/API/Request". - page-type
-
Der
page-typeSchlüssel für Web/API Schnittstellen ist immerweb-api-interface. - status
-
Flags, die den Status dieser Funktion beschreiben. Ein Array, das einen 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 "Wie Feature-Status hinzugefügt oder aktualisiert werden". - browser-compat
-
Ersetzen Sie den Platzhalterwert
path.to.feature.NameOfTheMethodmit der Abfragezeichenfolge für die Methode im Browser compat data repo. Die Toolchain verwendet automatisch den Schlüssel, um die Bereiche Kompatibilität und Spezifikation zu füllen (ersetzt die{{Compat}}und{{Specifications}}Makros).
Beachten Sie, dass Sie zunächst 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 zur Erstellung von Kompatibilitätstabellen.
Makros oben auf der Seite
Eine Anzahl von Makroaufrufen erscheint am Anfang des Inhaltsabschnitts (unmittelbar unter den Seiten-Metadaten).
Diese Makros werden automatisch von der Toolchain hinzugefügt (es ist nicht erforderlich, sie hinzuzufügen/zu entfernen):
{{SeeCompatTable}}— dies generiert ein Dies ist eine experimentelle Technologie-Banner, das darauf hinweist, dass die Technologie experimentell ist. Wenn sie experimentell ist und die Technologie in Firefox hinter einem Präf versteckt ist, sollten Sie auch einen Eintrag dafür auf der Seite Experimentelle Funktionen in Firefox ausfüllen.{{Non-standard_Header}}— dies generiert ein Nicht-standardisiertes Banner, das darauf hinweist, dass die Funktion nicht Teil einer Spezifikation ist.
Sie sollten die folgenden Makros entsprechend den untenstehenden Empfehlungen aktualisieren oder löschen:
{{SecureContext_Header}}— dies generiert ein Sicheres Kontext-Banner, das darauf hinweist, dass die Technologie nur in einem sicheren Kontext verfügbar ist. Falls nicht, können Sie den Makroaufruf entfernen. Wenn sie es ist, sollten Sie auch einen Eintrag dafür auf der Seite Funktionen, die auf sichere Kontexte beschränkt sind ausfüllen.{{AvailableInWorkers}}— dies generiert einen Verfügbar in Workern Hinweis, der darauf hinweist, dass die Technologie im Worker-Kontext verfügbar ist. Wenn es nur im Fensterkontext verfügbar ist, können Sie den Makroaufruf entfernen. Wenn es auch im Worker-Kontext verfügbar ist oder nur dort verfügbar ist, müssen Sie möglicherweise einen Parameter hinzugeben, aufgrund der Verfügbarkeit (siehe {{AvailableInWorkers}} Makro Quellcode für alle verfügbaren Werte), Sie müssen möglicherweise auch einen Eintrag dafür auf der Seite Web APIs verfügbar in Workern ausfüllen.{{APIRef("GroupDataName")}}— dies generiert das Referenzseitenleisten links, das schnelle Referenzlinks im Zusammenhang mit der aktuellen Seite zeigt. 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 Gruppendateneintrag hinzufügen und den Namen des Eintrags innerhalb des Makroaufrufs anstelle von GroupDataName einfügen. Siehe unseren API-Referenzseitenleisten Leitfaden für Informationen, wie dies zu tun ist.
Stellen Sie keine Status-Header-Makros manuell bereit. Verweisen Sie auf den Abschnitt "Wie Feature-Status hinzugefügt oder aktualisiert werden", um diese Status zur Seite hinzuzufügen.
Beispiele für die Sicheren Kontext, Verfügbar in Workern, Experimentell, Veraltet, und Nicht-standardisiert Banner werden direkt nach diesem Notizblock gezeigt.
Denken Sie daran, diese gesamte erläuternde 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.
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 Zusammenfassungsabsatz — beginnen Sie mit der Benennung 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 davon 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 im Markdown-Dokument.
Konstruktor
{{DOMxRef("NameOfTheInterface.NameOfTheInterface", "NameOfTheInterface()")}}-
Erstellt eine neue Instanz des
NameOfTheInterfaceObjekts.
Statische Eigenschaften
Erbt auch Eigenschaften von seiner übergeordneten Schnittstelle, {{DOMxRef("NameOfParentInterface")}}. (Hinweis: Wenn die Schnittstelle nicht von einer anderen Schnittstelle erbt, entfernen Sie diese ganze Zeile.)
Geben Sie einen Begriff und eine Definition für jede Eigenschaft an.
{{DOMxRef("NameOfTheInterface.staticProperty1")}}Schreibgeschützt-
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
Erbt auch Eigenschaften von seiner übergeordneten Schnittstelle, {{DOMxRef("NameOfParentInterface")}}. (Hinweis: Wenn die Schnittstelle nicht von einer anderen Schnittstelle erbt, entfernen Sie diese ganze Zeile.)
Geben Sie einen Begriff und eine Definition für jede Eigenschaft an.
{{DOMxRef("NameOfTheInterface.property1")}}Schreibgeschützt-
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: Wenn die Schnittstelle nicht von einer anderen Schnittstelle erbt, entfernen Sie diese ganze Zeile.)
Geben Sie einen Begriff und eine Definition für jede Methode an.
{{DOMxRef("NameOfTheInterface.staticMethod1()")}}-
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
Erbt auch Methoden von seiner übergeordneten Schnittstelle, {{DOMxRef("NameOfParentInterface")}}. (Hinweis: Wenn die Schnittstelle nicht von einer anderen Schnittstelle erbt, entfernen Sie diese ganze Zeile.)
Geben Sie einen Begriff und eine Definition für jede Methode an.
{{DOMxRef("NameOfTheInterface.method1()")}}-
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: Wenn die Schnittstelle nicht von einer anderen Schnittstelle erbt, entfernen Sie diese ganze Zeile.)
Hören Sie auf diese Ereignisse mit addEventListener() oder durch Zuweisung eines Ereignis-Listeners zur oneventname Eigenschaft dieser Schnittstelle.
{{DOMxRef("NameOfTheInterface.event1", "event1")}}-
Wird ausgelöst, wenn (fügen Sie die Beschreibung hinzu, wann das Ereignis ausgelöst wird). Auch verfügbar über die
oneventname1Eigenschaft. Wenn das Ereignis nicht experimentell/veraltet/nicht-standardisiert ist, entfernen Sie die entsprechenden Makroaufrufe. {{DOMxRef("NameOfTheInterface.event2", "event2")}}-
Wird ausgelöst, wenn (fügen Sie die Beschreibung hinzu, wann das Ereignis ausgelöst wird). Auch verfügbar über die
oneventname2Eigenschaft. Wenn das Ereignis nicht experimentell/veraltet/nicht-standardisiert 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 beschreibend dafür sein, was das Beispiel tut. Zum Beispiel "Ein einfaches Beispiel" sagt 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 Sie Codebeispiele hinzufügen können, für weitere 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 eine H3-Überschrift (###) für jedes Beispiel auf dieser Seite 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
### Nutzung 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 einfach die Links direkt unter die H2-Überschrift "Beispiele" hinzu. Zum Beispiel:
## Beispiele
Für Beispiele zu dieser API siehe [die Seite zu fetch()](https://example.org/).
Spezifikationen
{{Specifications}}
Um dieses Makro zu verwenden, entfernen Sie die Backticks und den Backslash im Markdown-Dokument.
Browser-Kompatibilität
{{Compat}}
Um dieses Makro zu verwenden, entfernen Sie die Backticks und den Backslash im Markdown-Dokument.
Siehe auch
Fügen Sie Links zu Referenzseiten und Leitfäden hinzu, die sich auf die aktuelle API beziehen. Für weitere Richtlinien siehe die Abschnitt "Siehe auch" im Writing style guide.
- link1
- link2
- external_link (Jahr)