API:Hauptseite

From MediaWiki.org
Jump to: navigation, search
This page is a translated version of the page API:Main page and the translation is 80% complete.

Other languages:
العربية • ‎български • ‎বাংলা • ‎català • ‎Deutsch • ‎English • ‎español • ‎فارسی • ‎français • ‎हिन्दी • ‎Հայերեն • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎ಕನ್ನಡ • ‎한국어 • ‎lietuvių • ‎मैथिली • ‎मराठी • ‎Nederlands • ‎occitan • ‎polski • ‎پښتو • ‎português • ‎português do Brasil • ‎română • ‎русский • ‎سنڌي • ‎українська • ‎粵語 • ‎中文
Tools clipart.png Diese Seite ist Teil der MediaWiki action API-Dokumentation.
MediaWiki APIAPI:Main page

MediaWiki action API

v · d · e
Dies ist ein Überblick über die „action“ API. Verwende die Menüleiste auf der rechten Seite für detailliertere Unterthemen und andere APIs.

Der MediaWiki Internetservice API (oder WebAPI) bietet bequemen Zugriff auf Wiki-Funktionen, Daten und Metadaten über HTML, normalerweise auf der URL api.phpManual:api.php. Clients fragen bestimmte "actions", mithilfe des action Parameters ab, meist action=query, um Informationen zu erhalten. Es war mal die MediaWiki API, aber mittlerweile gibt es auch weitere APIs zur Verbindung mit MediaWiki, z.B. RESTBase und Wikidata query service.

Einführung[edit]

Note Hinweis: Wenn du stattdessen auf der Suche nach einer „internal API“ oder „PHP API“ bist, sieh dir die Erweiterungsschnittstelle an, die PHP-Entwicklern erlaubt, neue Funktionen zu einer MediaWiki-Installation hinzuzufügen.

Die MediaWiki action API kann benutzt werden, um eine MediaWiki-Installation zu überwachen, oder einen Bot zu erstellen um automatisch eine aufrecht zu erhalten. Es bietet direkten High-Level-Zugriff auf die Daten in der MediaWiki-Datenbank. Client-Programme (z.B. Bots) können diese API nutzen, um sich einzuloggen, Daten abzurufen und Änderungen automatisch abzuschicken, indem HTTP-Anfragen an den Web-Service gemacht werden. Unterstützte Clients sind Bots, thin-webbased JavaScript-Clients wie z.B. Navigation Popups und LiveRC, Endbenutzer-Anwendungen wie z.B. Vandal Fighter und andere Webseiten (Tool Labs's Dienstprogramme).

Auf neue MediaWiki-Installationen wird der Web-Service standardmäßig aktiviert, der Administrator kann sie aber deaktivieren.

MediaWiki hat zwei weitere nach außen gewandte Schnittstellen:

Ein einfaches Beispiel[edit]

Diese URL teilt der Internetservice API der englischen Wikipedia mit, dir den Inhalt der Hauptseite zu senden:

https://en.wikipedia.org/w/api.php?action=query&titles=Main%20Page&prop=revisions&rvprop=content&format=json

Verwende eine beliebige Programmiersprache um eine HTTP-GET-Anfrage für die URL zu senden (oder besuchen Sie einfach diesen Link in Ihren Browser), und Sie werden ein JSON-Dokument erhalten, welches das aktuelle Wiki-Markup für die Seite mit dem Titel „Main Page“ enthält. Änderung des Formats zu jsonfm liefert für die Fehlersuche gut geeignete „pretty-print“ Version in HTML.

Hier ist die jsonfm URL als besser lesbarer, anklickbarer Link.

Zerlegen wir diese URL in ihre Bestandteile, um die Funktionsweise zu demonstrieren.

Der Endpunkt[edit]

https://en.wikipedia.org/w/api.php

Dies ist der Endpunkt Er ist so etwas, wie die Hauptseite der MediaWiki web service API. Diese URL ist die Basis-URL für die API der englischen Wikipedia, genauso wie https://en.wikipedia.org/wiki/ die Basis-URL für die zugehörige Webseite ist.

Wenn Du ein Programm schreibst, dass auf die API der englischsprachigen Wikipedia zurückgreift, wird jede URL, die Du verwendest, mit dieser Basis-URL beginnen. Wenn Du eine andere MediaWiki Installation verwendest, musst Du zunächst ihren Endpunkt herausfinden und stattdessen diese URL verwenden. Alle Wikimedia Wikis haben Endpunkte, die diesem Muster folgen:

https://www.mediawiki.org/w/api.php     # MediaWiki API
https://en.wikipedia.org/w/api.php      # englische Wikipedia API
https://nl.wikipedia.org/w/api.php      # niederländische Wikipedia API
https://commons.wikimedia.org/w/api.php # Wikimedia Commons API


MediaWiki version: 1.17

Seit r75621, steht RSD für das Auffinden des Endpunktes zur Verfügung: Suche link rel="EditURI" im HTML Quellcode einer beliebigen Seite und extrahiere die api.php URL; der Link enthält weitere Informationen. Für dieses Wiki lautet sie zum Beispiel:

<link rel="EditURI" type="application/rsd+xml" href="//www.mediawiki.org/w/api.php?action=rsd" />

Andernfalls gibt es keinen sicheren Weg den Endpunkt eines Wikis zu lokalisieren. Falls Du Glück hast, ist der volle Pfad zu index.php nicht unter eigenartigen rewrite rules versteckt, sodass Du lediglich dem edit (oder history) Link folgen und index.php (etc.) mit api.php ersetzen musst, oder es ist möglich den Standard script path (wie w/api.php) zu verwenden.

Nun weiter zu den einzelnen Parametern der Abfrage.

Das Format[edit]

format=json Die teilt der Wikimedia web service API mit, dass wir die Daten im JSON Format erhalten möchten. Vielleicht möchtest Du auch format=jsonfm ausprobieren, um eine HTML Version zu erhalten, die gut für die Fehlersuche ist. Die API unterstützt weitere output formats, wie XML und native PHP, allerdings gibt es Pläne weniger populäre Formate zu entfernen (phab:T95715), sodass Du sie eventuell nicht verwenden möchtest.

Die Aktion[edit]

action=query

Die MediaWiki Web Service API implementiert Dutzende von Aktionen und Erweiterungen; die dynamisch generierte API help dokumentiert alle innerhalb eines Wikis verfügbaren Aktionen. In diesem Fall, benutzen wir die Aktion „query“ um Informationen zu erhalten. The "query" action is one of the API's most important actions, and it has extensive documentation of its own. Was folgt ist lediglich die Erklärung eines einzigen Beispiels.

Aktionsspezifische Parameter[edit]

titles=Main%20Page

Der Rest der Beispiel-URL enthält Parameter, die von der „query“ Aktion verwendet werden. Hier teilen wir der web service API mit, dass wir an Informationen über eine Wiki Seite mit dem Namen „Main Page“ interessiert sind. (Die %20 rührt von Prozentcodierung der Leerzeichen her.) Wenn Du mit mehreren Seiten arbeitest, versuche bitte diese in eine einzige Abfrage zu packen um Netzwerk- und Serverressourcen optimal zu nutzen: titles=PageA|PageB|PageC Siehe query documentation für weitere Details.

prop=revisions

Dieser Parameter teilt der web service API mit, dass wir an einer speziellen Revision der Seite interessiert sind. Da wir keine Angabe über eine spezielle Revision machen, wird uns die API Informationen über die letzte Revision liefen; die Hauptseite der Wikipedia in ihrem aktuellen Stand.

rvprop=content

Dieser Parameter teilt der web service API mit, dass wir den Inhalt der letzten Revision der Seite möchten. Wenn wir stattdessen rvprop=content|user übergeben würden, bekämen wir den neuesten Seiteninhalt und den Namen des Benutzers, der die neueste Version schuf.

Noch einmal, dies ist lediglich ein Beispiel. Eine detailliertere Erklärung von Abfragen findet sich here, und the API reference listet alle möglichen Aktionen, alle möglichen Werte für rvprop, und so weiter auf.

Eine Einführung zur API von Roan Kattouw auf der Veranstaltung San Francisco Hackathon January 2012


Erste Schritte[edit]

Bevor Du beginnst, die MediaWiki web service API zu verwenden, stelle sicher, dass Du die folgenden Dokumente gelesen hast.

Von da an hängt das, was Du lesen musst, davon ab, was Du tun möchtest. Das Menü auf der rechten Seite bringt Dich zur detaillierten, aufgabenorientierten Dokumentation. Weitere allgemeine Guidelines findest du untenstehend.

Identifizere deinen Client[edit]

Wenn du HTTP Anfragen zu der MediaWiki web service API machst, stelle sicher, dass der User-Agent Header deinen Client richtig identifiziert. Brauche nicht den standardmässigen User-Agent der von der client library bereitgestellt wird, sondern erstelle einen eigenen Header der dein Skript oder Service identifiziert and stelle ein Weg bereit, um dich zu kontaktieren, z.B. eine E-Mail Adresse

Eine Beispiel User-Agent Nachricht sieht vielleicht so aus:

MyCoolTool/1.1 (https://example.org/MyCoolTool/; MyCoolTool@example.org) BasedOnSuperLib/1.4

Wenn du auf Wikimedia-Wikis keinen User-Agent bereitstellst, er leer ist oder du einen Standardmässigen verwendest, wird deine Anfrage mit dem HTTP Error-Code 403 fehlschlagen (Siehe m:User-Agent policy). Andere MediaWiki Installationen können ähnliche Richtlinien haben.

Wenn du die API vom browser-basierten JavaScript aufrufst, kannst du den User-Agent-Header nicht beeinflussen: Der Browser verwendet seinen eigenen. Um das zu umgehen, brauch den Api-User-Agent-Header:

// Using XMLHttpRequest
xhr.setRequestHeader( 'Api-User-Agent', 'Example/1.0' );

// Using jQuery
$.ajax( {
    url: remoteUrlWithOrigin,
    data: queryData,
    dataType: 'json',
    type: 'POST',
    headers: { 'Api-User-Agent': 'Example/1.0' },
    success: function(data) {
       // do something with data
    }
} );

// Using mw.Api, specify it when creating the mw.Api object
var api = new mw.Api( {
    ajax: {
        headers: { 'Api-User-Agent': 'Example/1.0' }
    }
} );
api.get( {...} ).done(function(data) {
    // do something with data
});

In PHP kannst du den user-agent folgendermassen identifizieren:

ini_set('user_agent', 'MyCoolTool/1.1 (https://example.org/MyCoolTool/; MyCoolTool@example.org) BasedOnSuperLib/1.4');

Oder wenn du cURL brauchst:

curl_setopt($curl, CURLOPT_USERAGENT, 'MyCoolTool/1.1 (https://example.org/MyCoolTool/; MyCoolTool@example.org) BasedOnSuperLib/1.4');

Anmelden[edit]

Dein Client wird sich wahrscheinlich auf MediaWiki einloggen müssen, vielleicht mit einem eigenen Benutzeraccount. Siehe Das Login-Manual für weitere Details.

API beschriftung[edit]

"Bitte auch lesen: API: Beschriftung"

Wenn deine Anfragen Daten erhalten, die man zwischenspeichern kann, solltest du die Daten auch zwischenspeichern, damit du nicht die gleichen Daten immer wieder anfragen musst. Weitere informationen über Anfragen-Limiten, Nebenläufigkeit und die generelle API Etikette kann hier gefunden werden: API: Etikette. Manche Cients können vielleicht selber Daten zwischenspeichern, aber für andere (genauer gesagt JavaScript) ist das nicht möglich.

Per the HTTP specification, POST requests cannot be cached. Therefore, whenever you're reading data from the web service API, you should use GET requests, not POST.

Also note that a request cannot be served from cache unless the URL is exactly the same. If you make a request for api.php?....titles=Foo|Bar|Hello, and cache the result, then a request for api.php?....titles=Hello|Bar|Hello|Foo will not go through the cache — even though MediaWiki returns the same data!

You should take care to normalize the URLs you send to the MediaWiki web service, so that slightly different user input won't cause you to waste time on unnecessary HTTP requests. You can normalize a list of page titles by removing duplicates and sorting the titles alphabetically. Similar techniques will work for other kinds of data.

Nützliche Links[edit]

The menu bar on the right side of this page links to more detailed, task-specific documentation. Here are some links having to do with the API as a whole:

Archived links[edit]