API Landingpage-Vorlage

Note: Entfernen Sie diese gesamte Erklärung, bevor Sie sie veröffentlichen.

Seitenmetadaten:

Die Metadaten oben auf der Seite definieren "Seitenmetadaten". Die Werte sollten für die jeweilige Schnittstelle entsprechend aktualisiert werden.
md
---
title: NameOfTheAPI API
slug: Web/API/NameOfTheAPI_API
page-type: web-api-overview
status:
  - deprecated
  - experimental
  - non-standard
---
title

Titelüberschrift, die oben auf der Seite angezeigt wird. Dies ist der Name der API, gefolgt vom Text "API": NameOfTheAPI API. Zum Beispiel hat die WebXR Device den Titel WebXR Device API, Fetch hat den Titel Fetch API.

slug

Das Ende des URL-Pfads nach https://developer.mozilla.org/de/docs/). Dies wird formatiert wie Web/API/NameOfTheAPI_API. Zum Beispiel hat die WebXR Device API den Slug Web/API/WebXR_Device_API.

page-type

Der page-type-Schlüssel für Web/API-Einstiegsseiten ist immer web-api-overview.

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 Funktionsstatus hinzugefügt oder aktualisiert werden".

Makros am Seitenanfang

Eine Reihe von Makroaufrufen erscheint oben im Inhaltsbereich (unmittelbar unter den Seitenmetadaten).

Diese Makros werden automatisch durch die Toolchain hinzugefügt (es ist nicht erforderlich, sie hinzuzufügen/entfernen):

{{SeeCompatTable}} — Dies erzeugt ein Diese Technologie ist experimentell Banner, das darauf hinweist, dass die Technologie experimentell ist. Falls es experimentell ist und die Technologie in Firefox hinter einem Pref verborgen ist, sollten Sie auch einen Eintrag auf der Seite Experimentelle Funktionen in Firefox einfügen.

{{Deprecated_Header}} — Dies erzeugt ein Obsolet Banner, das darauf hinweist, dass die Nutzung der Technologie abgeraten wird.

{{Non-standard_Header}} — Dies erzeugt ein Nicht-standard Banner, das darauf hinweist, dass die Funktion nicht Teil einer Spezifikation ist.

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

{{SecureContext_Header}} — Dieses Banner zeigt an, dass die Technologie nur in einem sicheren Kontext verfügbar ist. Wenn dies nicht der Fall ist, können Sie den Makroaufruf entfernen. Wenn dies der Fall ist, sollten Sie auch einen Eintrag auf der Seite Funktionen, die auf sichere Kontexte beschränkt sind hinzufügen.

{{AvailableInWorkers}} — Dies erzeugt eine Verfügbar in Arbeitern Notiz, die darauf hinweist, dass die Technologie im Arbeiter-Kontext verfügbar ist. Wenn sie nur im Fensterkontext verfügbar ist, können Sie den Makroaufruf entfernen. Wenn sie auch im Arbeiter-Kontext oder nur dort verfügbar ist, müssen Sie möglicherweise ein Parameter übergeben, abhängig von ihrer Verfügbarkeit (siehe {{AvailableInWorkers}} Makro-Codequelle für alle verfügbaren Werte). Möglicherweise müssen Sie auch einen Eintrag in der Web-APIs verfügbar in Arbeitern Seite hinzufügen.

{{APIRef("GroupDataName")}} — Dies erzeugt die linksseitige Referenz-Sidebar mit Schnellverweis-Links, die mit der aktuellen Seite verbunden sind. Zum Beispiel hat jede Seite in der WebVR API dieselbe 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 GitHub-Repo hinzufügen und den Namen des Eintrags im Makroaufruf anstelle von GroupDataName einfügen. Siehe unseren API-Referenz-Sidebars Leitfaden für Informationen, wie dies zu tun ist.

Denken Sie daran, das {{MDNSidebar}}-Makro zu entfernen, wenn Sie diese Seite kopieren.

Fügen Sie Status-Header-Makros nicht manuell hinzu. Siehe 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 Arbeitern, Experimentell, Obsolet und Nicht-standard Banner werden direkt nach diesem Hinweisblock gezeigt.

Browser-Kompatibilität

API-Einstiegsseiten haben optional einen Browser-Kompatibilitätsabschnitt, der Kompatibilitätstabellen für eine oder mehrere der wichtigsten Schnittstellen in der API anzeigt. Wenn die Kompatibilität für die meisten Schnittstellen in der API ähnlich ist, ist oft nur eine Kompatibilitätstabelle erforderlich. Wenn die Kompatibilität in der API kompliziert/unmöglich in wenigen Tabellen darzustellen ist, sollte dieser Abschnitt weggelassen werden.

Um den Browser-Kompatibilitätsabschnitt auszufüllen, müssen Sie möglicherweise zuerst Einträge für die API-Schnittstellen in unserem Browser compat data repo erstellen/aktualisieren — siehe unseren Leitfaden, wie dies zu tun ist.

Verwenden Sie das {{Compat}}-Makro, um die Tabellen für die Browser-Kompatibilitätsinformationen hinzuzufügen.

Spezifikationen

API-Landingpages haben optional einen Spezifikationsabschnitt, der die relevanten Spezifikationen für jede Schnittstelle auflistet. Oft gibt es nur eine Spezifikation, die alle Schnittstellen in der API abdeckt.

Um den Spezifikationsabschnitt auszufüllen, müssen Sie möglicherweise zuerst Einträge für Schnittstellen im Browser compat data repo erstellen/aktualisieren, um Spezifikationsdaten einzuschließen — siehe unseren Leitfaden, wie dies zu tun ist.

Verwenden Sie das {{Specifications}}-Makro, um die Tabellen für die Hauptspezifikationen hinzuzufügen.

Denken Sie daran, diese ganze Erklärung zu entfernen, bevor Sie sie veröffentlichen.

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 und befindet sich nicht auf dem Weg zur Standardisierung. Verwenden Sie sie nicht auf Produktionsseiten, die dem Web ausgesetzt sind: Sie funktioniert nicht für alle Benutzer. Es kann auch große Inkompatibilitäten zwischen Implementierungen geben, und das Verhalten kann sich in Zukunft ändern.

Beginnen Sie den Inhalt der Seite mit einem einleitenden Absatz — beginnen Sie mit der Benennung der API und sagen Sie, was sie tut. Dies sollte idealerweise ein oder zwei kurze Sätze sein.

Konzepte und Verwendung

Beschreiben Sie in diesem Abschnitt den Zweck der API und die Anwendungsfälle im Detail — warum wurde ein Bedarf dafür erkannt? Welche Probleme löst sie? Welche Konzepte sind involviert? Wie verwenden Sie sie, aus einer übergeordneten Perspektive?

Gehen Sie in diesem Abschnitt nicht ins Detail, und fügen Sie keine Codebeispiele hinzu. Wenn es viele Konzepte gibt, die um diese API erklärt werden müssen, sollten Sie sie in einem separaten Artikel "Grundlagen" oder "Konzepte" erklären (z.B. Grundlagen von WebXR). Für eine praktische Gebrauchsanleitung mit Codebeispielen sollten Sie einen "Verwendung…" Artikel in Ihren API-Dokumenten aufnehmen (z.B. Verwendung der WebVR API).

Um die Auffindbarkeit von Inhalten und SEO zu verbessern, beachten Sie die folgenden Tipps:

Schnittstellen

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

{{domxref("NameOfTheInterface")}}: Fügen Sie hier eine kurze Beschreibung der Schnittstelle und ihrer Funktionen ein. Fügen Sie für jede Schnittstelle oder jedes Wörterbuch einen Begriff und eine Definition ein.

Erweiterungen zu anderen Schnittstellen

Der Name der Schnittstelle erweitert die folgenden APIs, indem es die aufgelisteten Funktionen hinzufügt.

Schnittstelle 1

{{domxref("addition1")}}: Beschreibung der Funktion von Schnittstelle#1, die durch die von Ihnen derzeit dokumentierte API zu dieser API hinzugefügt wird. Ein *Begriff und Definition für jede Funktion. Wenn diese API keine anderen Schnittstellen erweitert, können Sie diese Abschnitte löschen.

Schnittstelle 2

{{domxref("addition1")}}: Beschreibung der Funktion von Schnittstelle#2, die durch die von Ihnen derzeit dokumentierte API zu dieser API hinzugefügt wird, usw.

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 sein, was das Beispiel tut. 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 Sie Codebeispiele hinzufügen, für weitere 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 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 dem 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 (Jahr)