Wikipedia:Technik/Datenbank/API

2025-02-12T13:38:56Z

46.114.166.180: /* Weitere Informationen */ lf

{{Shortcut}}
{{../../Linkbox}}
Die '''API''' ([[Programmierschnittstelle|Application Programming Interface]]) der Wiki-Projekte erlaubt die Abfrage von Informationen über Projekte oder Seiten, die auch automatisiert durch Software abgerufen und verarbeitet werden können; sowie automatisierte Bearbeitung von Seiten.

Grundsätzlich gibt es zwei Möglichkeiten:
# Manueller Abruf und Darstellung der Ergebnisse im Browser in einer menschenlesbar aufbereiteten [[Extensible Markup Language|XML]]-Darstellung.
#* ''Beispiel:'' [https://de.wikipedia.org/w/api.php?action=query&list=exturlusage&eulimit=20&euquery=en.wikipedia.org Aufrufe der englischsprachigen Wikipedia] aus der deutschsprachigen Wikipedia heraus.
# Automatisierter Abruf durch Programme und Skripte. Das Abfrageergebnis wird typischerweise in [[JavaScript Object Notation|JSON]] oder XML zurückgegeben und durch Software ausgewertet. Siehe dazu [[Wikipedia:Technik/Skin/JS/API|JS/API]].

Die Informationen auf [[Hilfe:Spezialseiten|Spezialseiten]] können in den meisten Fällen auch über API-Aufrufe gewonnen werden; nur die optische Darstellung auf den Spezialseiten unterscheidet sich. Technisch liegt das gleiche Prinzip der Datenbankabfragen zugrunde. Dafür bieten API-Abfragen meist mehr individuelle Steuerungsmöglichkeiten: Während etwa auf [[Spezial:Weblinksuche]] zurzeit keine Filterung nach Namensräumen möglich ist, kann das mit der API beliebig zusammengestellt und kombiniert werden.

Die [[Uniform Resource Locator|URL]] sieht so aus wie sonst bei dynamischen Seiten; jedoch heißt es bei der klassischen API <code>api.php</code> statt <code>index.php</code> im Pfad.

== Dokumentation der Funktionalität ==
Es gibt unterschiedlich vollständige Informationen in deutscher und englischer Sprache:
* [[mw:Special:MyLanguage/API:Main page|mw:API]] – Kernfunktionen, deutschsprachige Dokumentation.
** Nicht alle Themen übersetzt; nicht jede technische Einzelheit erwähnt und aktuell.
* [[mw:API:Main page]] – englischsprachige Dokumentation der Kernfunktionen; Stammseite auf [[MediaWiki]].
** umfassender, aber auch nicht immer vollständig und aktuell
* Zusätzlich zu den Kernfunktionen gibt es Erweiterungen mit eigenen API-Abfragen unter [[mw:Category:API extensions|API extensions]].
* [https://de.wikipedia.org/w/api.php api.php] – automatisch generierte Dokumentation, die stets aktuell ist und neben Kernfunktionen auch die gültigen Erweiterungen enthält; englisch, teilweise auch übersetzt.

== Erprobung ==
* Normale Abfragen lassen sich durch Bildung einer entsprechenden [[Uniform Resource Locator|URL]] gleich in jedem Browser testen ([[Hypertext Transfer Protocol#HTTP GET|HTTP-GET]]).
* Bestimmte (verändernde) Aktionen benötigen [[Hypertext Transfer Protocol#HTTP POST|HTTP-POST]]; dafür wurde die Spezialseite [[Special:APISandbox]] eingerichtet. Sie führt diese Aktionen allerdings wirklich aus!

== REST ==
Langfristig ist ein neuer Ansatz mit fortgeschrittener Technologie und erweiterten Möglichkeiten geplant: [[Representational State Transfer]] (REST).
* ''[[mailarchive:wikitech-l/2015-March/081135.html|Wikimedia REST content API is now available in beta]]''. 10. März 2015
* [https://de.wikipedia.org/api/rest_v1/?doc Generierte Dokumentation für dewiki]
* Die URL enthält <code>/rest.php</code> oder <code>/api/rest</code> statt <code>index.php</code> im Pfad.

== Fehler und Probleme ==
Die [[Wikipedia:Technik/Werkstatt|Technik-Werkstatt]] hilft weiter.

== Weitere Informationen ==
{{MediaWiki|API/de|Alle APIs}}
<noinclude>
[[Kategorie:Wikipedia:Technik/Datenbank|API]]
</noinclude>

Wikipedia (Deutsch) – Lokale Kopie - Benutzerbeiträge [de]

Wikipedia:Technik/Datenbank/API