API-Landingpage-Vorlage

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

Seiten-Metadaten:

Die „front matter“ am oberen Rand der Seite wird verwendet, um „Seitenmetadaten“ zu definieren. 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:
  - experimental
  - deprecated
  - 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 WebXR Device den Titel WebXR Device API, Fetch hat den Titel Fetch API.

slug

Der Endteil des URL-Pfads nach https://developer.mozilla.org/de/docs/). Dies wird formatiert wie Web/API/NameOfTheAPI_API. Zum Beispiel ist der Slug der WebXR Device API Web/API/WebXR_Device_API.

page-type

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

status

Flags, die den Status dieser Funktion 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 den Werten der Browser-Kompatibilitätsdaten für die Funktion gesetzt. Siehe "Anleitung zum Hinzufügen oder Aktualisieren von Feature-Status".

Top-of-page-Makros

Eine Anzahl von Makroaufrufen erscheint oben im Inhaltsbereich (unmittelbar unter der Seiten-Metadaten).

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

  • {{SeeCompatTable}} — Dies erzeugt ein This is an experimental technology Banner, das anzeigt, dass die Technologie experimentell ist. Wenn sie experimentell ist und die Technologie hinter einem Pref in Firefox versteckt ist, sollten Sie auch einen Eintrag dafür auf der Seite Experimentelle Funktionen in Firefox ausfüllen.
  • {{Deprecated_Header}} — Dies erzeugt ein Deprecated Banner, das indiziert, dass die Verwendung der Technologie nicht empfohlen wird.
  • {{Non-standard_Header}} — Dies erzeugt ein Non-standard Banner, das anzeigt, dass das Feature nicht Teil einer Spezifikation ist.

Sie sollten die folgenden Makros entsprechend der unten stehenden Ratschläge aktualisieren oder löschen:

  • {{SecureContext_Header}} — Dies erzeugt ein Sicherer Kontext Banner, das anzeigt, dass die Technologie nur in einem sicheren Kontext verfügbar ist. Wenn dem nicht so 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}} — Dies erzeugt eine Available In Workers Notiz, die anzeigt, dass die Technologie im Worker-Kontext verfügbar ist. Wenn sie nur im Window-Kontext verfügbar ist, können Sie den Makroaufruf entfernen. Wenn sie auch oder nur im Worker-Kontext verfügbar ist, müssen Sie möglicherweise ein Parameter aufgrund ihrer Verfügbarkeit übergeben (siehe für alle verfügbaren Werte den

    Hinweis: Dieses Feature ist verfügbar in Web Workers.

    Makros Quellcode), möglicherweise müssen Sie auch einen Eintrag dafür auf der Seite Web-APIs, die in Workern verfügbar sind ausfüllen.
  • {{APIRef("GroupDataName")}} — Dies erzeugt die linksseitige Referenz-Sidebar, die Schnellzugriffslinks zeigt, die sich auf die aktuelle Seite beziehen. Zum Beispiel hat jede Seite in der WebVR API dieselbe 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 in unserem GitHub-Repo hinzufügen und den Namen des Eintrags im Makro-Aufruf anstelle von GroupDataName verwenden. Siehe unseren API-Referenz-Sidebars Leitfaden, um Informationen dazu zu erhalten.
  • Denken Sie daran, das {{MDNSidebar}} Makro zu entfernen, wenn Sie diese Seite kopieren.

Geben Sie keine Status-Header-Makros manuell an. Folgen Sie dem Abschnitt "Anleitung zum Hinzufügen oder Aktualisieren von Feature-Status", um diese Status zur Seite hinzuzufügen.

Beispiele der Secure context, Available in workers, Experimental, Deprecated, und Non-standard Banner werden direkt nach diesem Hinweisblock gezeigt.

Browser-Kompatibilität

API-Landingpages haben optional einen Bereich zur Browser-Kompatibilität, der Kompatibilitätstabellen für eine oder mehrere der wichtigsten Schnittstellen in der API zeigt. Wenn die Kompatibilität für die meisten Schnittstellen in der API ähnlich ist, wird oft nur eine Kompatibilitätstabelle benötigt. Wenn die Kompatibilität über die API hinweg kompliziert/unmöglich in wenigen Tabellen darzustellen ist, sollte dieser Abschnitt weggelassen werden.

Um den Browser-Kompatibilitätsbereich 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 dazu.

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

Spezifikationen

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

Um den Spezifikationsbereich 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 dazu.

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

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: 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.

Beginnen Sie den Inhalt auf der Seite mit einem einleitenden Absatz — nennen Sie zuerst die API und sagen, was sie macht. Dies sollte idealerweise ein oder zwei kurze Sätze sein.

Konzepte und Nutzung

In diesem Abschnitt beschreiben Sie den Zweck der API und die Nutzungsszenarien im Detail — warum wurde ein Bedarf dafür erkannt? Welche Probleme löst sie? Welche Konzepte beinhaltet sie? Wie verwendet man sie aus einer höheren Ebene?

Gehen Sie in diesem Abschnitt nicht in viele Details und fügen Sie keine Codebeispiele ein. Wenn es viele Konzepte zu erklären rund um diese API gibt, sollten Sie diese in einem separaten Artikel "Grundlagen" oder "Konzepte" erklären (z. B. Grundlagen von WebXR). Für einen praktischen Leitfaden zur Nutzung mit Codebeispielen sollten Sie einen "Nutzung…" Artikel in Ihre API-Dokumentation einfügen (z. B. Verwendung der WebVR API).

Um die Auffindbarkeit von Inhalten und SEO zu verbessern, beachten Sie folgende 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 einen Begriff und eine Definition für jede Schnittstelle oder jedes Wörterbuch hinzu.

Erweiterungen zu anderen Schnittstellen

Die Name der Schnittstelle erweitert die folgenden APIs, indem sie die aufgelisteten Features hinzufügt.

Schnittstelle 1

{{domxref("addition1")}}

Beschreibung des Features der Schnittstelle#1, das zu dieser API durch die API, die Sie derzeit dokumentieren, hinzugefügt wird. Ein *Begriff und eine Definition für jedes Feature. Wenn diese API keine anderen Schnittstellen erweitert, können Sie diese Abschnitte löschen.

Schnittstelle 2

{{domxref("addition1")}}

Beschreibung des Features der Schnittstelle#2, das zu dieser API durch die API, die Sie derzeit dokumentieren, 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 für das sein, 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 zum Hinzufügen von Codebeispielen für nähere 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 abschließende H3-Überschrift (###) mit dem Text "Weitere Beispiele", unter dem Sie auf die Beispiele auf anderen Seiten verlinken können. Zum Beispiel:

md
## Beispiele

### Verwendung der Fetch-API

Beispiel für Fetch

### Weitere Beispiele

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

md
## 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 in der Markdown-Datei.

Browser-Kompatibilität

{{Compat}}

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

Siehe auch

Fügen Sie Links zu Referenzseiten und Leitfäden hinzu, die sich auf die aktuelle API beziehen. Weitere Richtlinien finden Sie im Abschnitt Siehe auch im Schreibstil-Leitfaden.

  • link1
  • link2
  • externer_link (Jahr)