Die MediaWiki-API ist ein gut dokumentierter Satz von Entwicklungswerkzeugen, die die meisten Aufgaben in einem Skript erledigen können. Die API wird typischerweise für die Entwicklung von automatisierten Tools zur Verwendung im Wiki verwendet. Die MediaWiki-API kann von den meisten Sprachen problemlos verwendet werden, insbesondere von PHP (Die curl-Funktionen) sowie Perl und einigen anderen.
Schritte
Schritt 1. Lesen Sie die MediaWiki-API-Dokumentation
Sie befindet sich unter 'api.php' im selben Verzeichnis wie die übliche index.php. Beispiel:
Schritt 2. Wählen Sie ein Ausgabeformat aus
Das MediaWiki bietet eine Datenausgabe in Form von JSON, JSONFM, PHP (serialisiertes Format), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM und RAWFM. Die Formate mit dem Suffix "FM" sind in HTML hübsch gedruckt.
Schritt 3. Wählen Sie eine Aktion
Die MediaWiki-API unterstützt die folgenden Aktionen:
- Hilfe - Siehe den Hilfebildschirm
- Login - Einloggen in MediaWiki
- opensearch - Implementieren Sie das opensearch-Protokoll. (Nicht alle MediaWiki-Installationen haben dies).
- feedwatchlist – Gibt einen Watchlist-Feed zurück.
- Abfrage - Hat eine Vielzahl von Optionen. Siehe dazu die MediaWiki-API-Dokumentation.
Schritt 4. Wählen Sie eine Abfrage oder eine Liste aus
Neben den Standardaktionen unterstützt MediaWiki verschiedene Abfragen und Listen, wie z.
Schritt 5. Übergeben Sie die bereitgestellten Daten an die API mithilfe von CURL oder einem anderen Tool, mit dem Sie die POST-Methode für das Skript verwenden können
Die GET-Methode kann auch funktionieren.
Schritt 6. Stellen Sie sicher, dass Cookies an eine Anwendung gesendet werden (Einige Skripte/Anwendungen möchten sie möglicherweise in einem Unterordner speichern
Schritt 7. Achten Sie bei der Interaktion mit der MediaWiki-Benutzeroberfläche darauf, dass Ihr Bearbeitungs-Token auf den meisten Bearbeitungsseiten aufbewahrt wird
Das Bearbeitungstoken wird verwendet, um Bearbeitungskollisionen zu bestimmen und zu vermeiden, dass eine andere bereits durchgeführte Bearbeitung überschrieben wird (dies wird auch beim Rollback verwendet.). Denken Sie daran, dass es leichter schief gehen kann, wenn Sie mit der Benutzeroberfläche des Wikis agieren. Achten Sie auf alle Regexes, die Sie verwenden, um sicherzustellen, dass sie nur das beabsichtigte Ergebnis ausführen.
Schritt 8. Lesen Sie die vom Wiki gesendeten Ergebnisse
Die Ergebnisse werden Ihnen in einer HTTP-Antwort zugesandt, die von vielen Parsern gelesen werden kann. Achten Sie besonders auf das von Ihnen gewählte Format. Stellen Sie sicher, dass Sie den entsprechenden Parser für dieses Format verwenden. Normalerweise empfiehlt es sich, MediaWiki das Format explizit anzugeben, selbst wenn es ein Standardformat hat, das Sie verwenden möchten.
Tipps
- Stellen Sie sicher, dass Ihr lokales Wiki das Skript unterstützt, bevor Sie die API verwenden.
- Sie können mehr über MediaWiki erfahren, indem Sie seine API verwenden.
