MediaWiki API je dobře zdokumentovaná sada vývojových nástrojů, které mohou provádět většinu úkolů v jednom skriptu. API se obvykle používá pro vývoj automatizovaných nástrojů pro použití ve wiki. MediaWiki API lze snadno používat ve většině jazyků, zejména v PHP (funkce zvlnění), stejně jako v Perlu a několika dalších..
Kroky
Krok 1. Přečtěte si dokumentaci API MediaWiki
Je umístěn na 'api.php' ve stejném adresáři jako obvyklý index.php. Příklad:
Krok 2. Vyberte výstupní formát
MediaWiki nabízí výstup dat ve formátech JSON, JSONFM, PHP (serializovaný formát), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM a RAWFM. Formáty s příponou „FM“se v HTML dobře tisknou.
Krok 3. Vyberte akci
MediaWiki API podporuje následující akce:
- nápověda - Podívejte se na obrazovku nápovědy
- přihlášení - Přihlášení do MediaWiki
- opensearch - Implementujte protokol opensearch. (Ne všechny instalace MediaWiki to mají).
- feedwatchlist - Vrací zdroj sledovaného seznamu.
- dotaz - má různé možnosti. Podívejte se na ně v dokumentaci API MediaWiki.
Krok 4. Vyberte dotaz nebo seznam
Kromě standardních akcí MediaWiki podporuje různé dotazy a seznamy, jako jsou stránky se seznamem, které obsahují odkaz na jiný článek, rozdíly v posledních změnách, příspěvky atd.
Krok 5. Předejte zveřejněná data do API pomocí CURL nebo jiného nástroje, který vám umožní použít metodu POST na skript
Metoda GET může také fungovat.
Krok 6. Zajistěte, aby byly soubory cookie odesílány do aplikace (Některé skripty/aplikace je mohou chtít uložit do podsložky
Krok 7. Při interakci s uživatelským rozhraním MediaWiki pamatujte na svůj token úprav uložený na většině stránek úprav
Úpravný token slouží k určení kolizí úprav a zamezení přepsání jiné již provedené úpravy (Toto se používá také při vrácení zpět.) Mějte na paměti, že je jednodušší, aby se věci pokazily, pokud jednáte s uživatelským rozhraním wiki. Mějte na paměti všechny regexy, které používáte, abyste se ujistili, že budou dělat pouze zamýšlený výsledek.
Krok 8. Přečtěte si výsledky zaslané wiki
Výsledky vám budou zaslány v odpovědi HTTP, kterou si může přečíst mnoho analyzátorů. Zvláštní pozornost věnujte zvolenému formátu. Ujistěte se, že používáte příslušný analyzátor pro daný formát. Obvykle je dobrým zvykem explicitně uvést formát MediaWiki, i když má výchozí formát, který chcete použít.
Tipy
- Před použitím rozhraní API se ujistěte, že máte podporu skriptu pro vaši místní wiki.
- Více o MediaWiki najdete pomocí jeho API.
