API:REST API/Reference/de

Die REST-API lässt dich durch das Absenden von HTTP-Abfragen an einzigartige URLs mit MediaWiki interagieren. Du kannst die API nutzen, um Apps und Skripte zu erstellen, die Wiki-Seiten und Versionsgeschichten durchsuchen.

= Suche =



Suchergebnisobjekt
Das Suchergebnisobjekt repräsentiert eine Wiki-Seite, die mit der angefragten Suche übereinstimmt.

Schema


Seiten suchen
Sucht nach Titeln von Wiki-Seiten und Inhalten für die angegebenen Suchbegriffe und gibt passende Seiten aus.

Antworten


Automatische Vervollständigung des Seitentitels
Sucht Titel von Wiki-Seiten und gibt Treffer zwischen dem Beginn eines Titels und den angegebenen Suchbegriffen aus. Du kannst diesen Endpunkt für eine Typeahead-Suche nutzen, die automatisch relevante Seiten anhand ihres Titels vorschlägt.

Antworten
= Seiten =



Seiten-Objekt
Das Seiten-Objekt repräsentiert die letzte Version einer Wiki-Seite.

Schema


Seitensprachen-Objekt
Das Seitensprachen-Objekt repräsentiert eine Wiki-Seite und ihre Sprache.

Schema


Seite erstellen
Erstellt eine Wiki-Seite. Die Antwort umfasst einen -Header, der den API-Endpunkt enthält, um die neue Seite zu erhalten.

Dieser Endpunkt wurde entworfen, um zusammen mit dem Autorisierungsprozess der OAuth-Erweiterung genutzt zu werden. Anrufer, die die Cookie-basierte Authentifizierung nutzen, müssen stattdessen ein CSRF- zum Abfragekörper hinzufügen. Um ein CSRF-Token zu erhalten, siehe die Action API.

Beispiele


Antworten


Eine Seite aktualisieren
Aktualisiert oder erstellt eine Wiki-Seite. Dieser Endpunkt wurde entworfen, um zusammen mit dem Autorisierungsprozess der OAuth-Erweiterung genutzt zu werden. Anrufer, die die Cookie-basierte Authentifizierung nutzen, müssen stattdessen ein CSRF- zum Abfragekörper hinzufügen. Um ein CSRF-Token zu erhalten, siehe die Action API.

Du benötigst die Kennung der letzten Version der Seite und die Quellseite. Rufe zunächst den Endpunkt an, um die Quellseite zu erhalten und nutze dann  und , um die Seite zu aktualisieren. Wenn  nicht mit der letzten Version einer Seite übereinstimmt, löst die API Konflikte automatisch, sofern dies möglich ist. Im Fall eines Bearbeitungskonfliktes, gibt die API einen 409-Fehler aus.

Lasse  bei der Abfrage weg, um eine Seite zu erstellen.

Parameter


Antworten


Seite erhalten
Gibt das Standard-Seiten-Objekt für eine Wiki-Seite mit dem API-Pfad zum Erhalt des letzten Inhalts in HTML, der Lizenz und Informationen über die letzte Version aus.

Antworten


Seite offline erhalten
Gibt Informationen über eine Wiki-Seite aus, darunter die Lizenz, die letzte Version und der letzte Inhalt in HTML.

Antworten


Quellseite erhalten
Gibt den Inhalt einer Wiki-Seite im durch die Eigenschaft  angegebenen Format, die Lizenz und Informationen über die letzte Version aus.

Antworten


HTML erhalten
Gibt den letzten Inhalt einer Wiki-Seite in HTML aus.

Antworten


Sprachen erhalten
Durchsucht verbundene Wikis nach Seiten mit dem gleichen Thema in einer anderen Sprache. Gibt ein Array der Seitensprachen-Objekte aus, das den Namen der Sprache, den Sprachcode und den übersetzten Seitentitel enthält.

Antworten


Dateien von einer Seite erhalten
Gibt Informationen über Mediendateien aus, die auf einer Wiki-Seite genutzt werden.

Transform
The transform endpoint provides on-the-fly round-trip conversion between wikitext and HTML.

Convert Wikitext to HTML
Converts wikitext to HTML.

Convert HTML to Wikitext
Converts wikitext to HTML.

Transform request body
Payload structure for transform requests.

Example
For converting wikitext to HTML:

For converting HTML to Wikitext:

 = Mediendateien =

<span id="File_object">

Datei-Objekt
Das Datei-Objekt repräsentiert eine Datei, die in einem Wiki hochgeladen wurde.

Schema
<span id="Get_file">

Datei erhalten
Gibt Informationen über eine Datei aus, darunter Links zum Herunterladen der Datei im Miniaturformat, Vorschauformat und originalen Format.

Responses
= Versionsgeschichte =

<span id="Revision_object">

Versionsobjekt
Das Versionsobjekt repräsentiert eine Änderung auf einer Wiki-Seite.

Schema
<span id="Get_page_history">

Versionsgeschichte erhalten
Gibt Informationen über die letzten Versionen einer Wiki-Seite in Bereichen von 20 Versionen, beginnend mit der letzten Version, aus. Die Antwort enthält API-Pfade für die nächstälteren, nächstneueren und die neuesten Versionsbereiche und ermöglicht es dir so, durch die Versionsgeschichte zu scrollen.

Antworten
<span id="Response_schema">

Antwort-Schema
<span id="Get_page_history_counts">

Versionszähler erhalten
Gibt Daten über die Versionsgeschichte einer Seite aus.

Antworten
<span id="Response_schema">

Antwort-Schema
<span id="Get_revision">

Version erhalten
Gibt Details für eine einzelne Version aus.

Antworten
<span id="Compare_revisions">

Versionen vergleichen
Gibt Daten aus, die dich Zeile für Zeile zwei Versionen vergleichen lassen. (Siehe ein Beispiel.) Nur textbasierte Wiki-Seiten können verglichen werden.

Antworten
<span id="Response_schema">