1. MDN Web Docs
  2. Schreibrichtlinien
  3. Seitenstrukturen
  4. Seitentypen
  5. API-Vorlagenseite

Dieser Inhalt wurde automatisch aus dem Englischen übersetzt, und kann Fehler enthalten. Erfahre mehr über dieses Experiment.

View in English Always switch to English

API-Vorlagenseite

Hinweis: Entfernen Sie diesen gesamten erläuternden Hinweis vor der Veröffentlichung

Seiteneinstellungen:

Das 'Front matter' am Anfang der Seite wird verwendet, um "Seiten-Metadaten" zu definieren. Die Werte sollten entsprechend der jeweiligen Schnittstelle aktualisiert werden.

md
---
title: NameOfTheAPI API
slug: Web/API/NameOfTheAPI_API
page-type: web-api-overview
status:
  - deprecated
  - experimental
  - non-standard
---
title

Überschrift, die oben auf der Seite angezeigt wird. Dies ist der Name der API gefolgt von dem Text "API": NameOfTheAPI API. Zum Beispiel hat die WebXR-Geräte-API den Titel WebXR-Geräte-API, die Fetch-API 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 ist der 'Slug' der WebXR-Geräte-API Web/API/WebXR_Device_API.

page-type

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

status

Flags, die den Status dieses Features 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 Werten in den Daten zur Browser-Kompatibilität für das Feature gesetzt. Siehe "Wie Feature-Status hinzugefügt oder aktualisiert werden".

Makros am Seitenanfang

Eine Reihe von Makroaufrufen erscheinen am Anfang des Inhaltsbereichs (direkt unter dem 'Front matter').

Diese Makros werden automatisch durch die Toolchain hinzugefügt (es ist nicht nötig, diese hinzuzufügen/zu entfernen):

  • {{SeeCompatTable}} — dies erzeugt 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 Präferenzwert versteckt ist, sollten Sie auch einen Eintrag dafür auf der Seite Experimentelle Funktionen in Firefox ausfüllen.
  • {{Non-standard_Header}} — dies erzeugt ein Nicht-standardisiert-Banner, das darauf hinweist, dass das Feature nicht Teil einer Spezifikation ist.

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

  • {{SecureContext_Header}} — dies erzeugt ein Sicherer Kontext-Banner, das darauf hinweist, dass die Technologie nur in einem sicheren Kontext verfügbar ist. Wenn dies nicht der Fall ist, können Sie den Makroaufruf entfernen. Wenn es ist, sollten Sie auch einen Eintrag dafür auf der Seite Funktionen, die auf sichere Kontexte beschränkt sind ausfüllen.
  • {{AvailableInWorkers}} — dies erzeugt eine In Workers verfügbar-Notiz, die 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 (oder nur dort) verfügbar ist, müssen Sie möglicherweise einen Parameter übergeben, aufgrund seiner Verfügbarkeit (siehe {{AvailableInWorkers}} Makroquellcode für alle verfügbaren Werte), Sie müssen möglicherweise auch einen Eintrag dafür in der Seite Web-APIs im Worker-Kontext verfügbar ausfüllen.
  • {{APIRef("GroupDataName")}} — dies erzeugt die linke Referenz-Seitenleiste mit Schnellreferenzlinks, die mit der aktuellen Seite zusammenhängen. Zum Beispiel hat jede Seite der WebVR-API dieselbe Seitenleiste, die auf die anderen Seiten in der API verweist. Um die korrekte Seitenleiste für Ihre API zu erzeugen, 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 Leitfaden zu API-Referenz-Seitenleisten für Informationen, wie dies zu tun ist.

Geben Sie keine Status-Header-Makros manuell ein. Lesen Sie den Abschnitt "Wie Feature-Status hinzugefügt oder aktualisiert werden", um diese Status der Seite hinzuzufügen.

Beispiele für die Sicherer Kontext, In Workers verfügbar, Experimentell, Veraltet und Nicht-standardisiert-Banner werden direkt nach diesem Hinweisblock gezeigt.

Browser-Kompatibilität

API-Startseiten haben optional einen Abschnitt zur Browser-Kompatibilität, der Kompatibilitätstabellen für eine oder mehrere der wichtigsten Schnittstellen der API anzeigt. 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 zu erfassen ist, sollte dieser Abschnitt weggelassen werden.

Um den Abschnitt zur Browser-Kompatibilität auszufüllen, müssen Sie möglicherweise zuerst Einträge für die API-Schnittstellen in unserem Browser-Kompatibilitäts-Daten-Repo erstellen/aktualisieren — siehe unseren Leitfaden, wie dies zu tun ist.

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

Spezifikationen

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

Um den Abschnitt zu Spezifikationen auszufüllen, müssen Sie möglicherweise zuerst Einträge für die Schnittstellen im Browser-Kompatibilitäts-Daten-Repo erstellen/aktualisieren, um Spezifikationsdaten einzuschließen — siehe unseren Leitfaden, wie dies zu tun ist.

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

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

Beginnen Sie den Inhalt der Seite mit einem einleitenden Absatz — beginnen Sie damit, die API zu benennen und zu erläutern, was sie tut. Dies sollte idealerweise ein oder zwei kurze Sätze sein.

Konzepte und Nutzung

Beschreiben Sie in diesem Abschnitt den Zweck der API und die Anwendungsfälle etwas detaillierter — warum wurde ein Bedürfnis dafür erkannt? Welche Probleme löst sie? Welche Konzepte beinhaltet sie? Wie verwendet man sie aus einer hohen Perspektive?

Gehen Sie in diesem Abschnitt nicht zu sehr ins Detail und fügen Sie keine Code-Beispiele ein. Wenn es viele Konzepte zu erklären gibt, sollten Sie diese in einem separaten "Grundlagen"- oder "Konzepte"-Artikel erklären (z.B. Grundlagen von WebXR). Für einen praktischen Anwendungsleitfaden mit Code-Beispielen sollten Sie einen "Anwendungs…" Artikel in Ihre API-Dokumentation einfügen (z.B. Verwendung der WebVR API).

Leitfäden

Fügen Sie eine Liste von Leitfäden unterhalb dieser Startseite ein. Jeder DT sollte mit der Seite des Leitfadens verlinkt sein. Dieser Abschnitt ist optional; wenn es nur einen einzigen "Anwendungs"-Leitfaden gibt, zusammen mit einigen anderen konzeptionellen Leitfäden, kann es praktischer sein, diese als Absatz am Ende des Abschnitts "Konzepte und Nutzung" zu verlinken. Dieser Abschnitt kann hilfreicher sein, wenn es so viele Leitfäden gibt, dass der Text schwer zu überfliegen ist.

Nutzung der ... API

Einführungstext dieser Leitfadenseite

Leitfaden 2

Einführungstext dieser Leitfadenseite

Schnittstellen

Um das domxref Makro zu verwenden, entfernen Sie die Rückstriche und die Backticks in der Markdown-Datei.

{{domxref("NameOfTheInterface")}}

Fügen Sie eine kurze Beschreibung der Schnittstelle und ihrer Funktion hier ein. Fügen Sie einen Begriff und die Definition für jede Schnittstelle oder jedes Wörterbuch hinzu.

Erweiterungen zu anderen Schnittstellen

Der Name der Schnittstelle erweitert die folgenden APIs, indem die aufgeführten Funktionen hinzugefügt werden.

Schnittstelle 1

{{domxref("addition1")}}

Beschreibung der Funktion von Schnittstelle#1, die durch die API, die Sie dokumentieren, zu dieser API hinzugefügt wird. Ein *Begriff und die 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 API, die Sie dokumentieren, zu dieser API hinzugefügt wird, usw.

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 tut. "Ein einfaches Beispiel" sagt zum 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 Code-Beispiele hinzufügt für weitere Informationen.

Hinweis: Manchmal möchten Sie auf Beispiele verlinken, die auf einer anderen Seite gegeben werden.

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 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 direkt unter der H2-Überschrift "Beispiele" hinzu. Zum Beispiel:

md
## Beispiele

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

Spezifikationen

{{Specifications}}

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

Browser-Kompatibilität

{{Compat}}

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

Siehe auch

Fügen Sie Links zu Referenzseiten und Leitfäden ein, die mit der aktuellen API zusammenhängen. Für weitere Richtlinien siehe den Siehe auch Abschnitt im Schreibstil-Leitfaden.

  • link1
  • link2
  • external_link (Jahr)

Help improve MDN

Erfahren Sie, wie Sie beitragen können Diese Seite wurde automatisch aus dem Englischen übersetzt.
Übersetzung auf GitHub anzeigen • Fehler mit dieser Übersetzung melden