API:Tutorial/cs

V tomto návodu se dozvíte o MediaWiki Action API, jak jej používat, formát požadavku, jednoduchý dotaz a příklady projektů využívajících Action API.

Procházejte ukázkové aplikace na Toolforge



Přehled rozhraní MediaWiki Action API
MediaWiki Action API je REST úplná webová služba, která uživatelům umožňuje provádět určité wiki-akce, např. vytváření stránek, ověřování, analyzování, vyhledávání atd. je dobrým výchozím bodem pro pochopení API.

Váš program odesílá požadavky do API, aby získal přístup k funkcím wiki. Například přihlášení na wiki, vytvoření a úpravu stránky, vyhledání názvu, vyhledání text obsahu nebo analýzu obsahu. Action API je k dispozici pro vývojáře třetích stran, vývojáře rozšíření Wikimedie a správce wiki stránek.

Na pravém postranním panelu této stránky je mnoho funkcí, které rozhraní API podporuje, seskupených podle kategorií. Před odesláním požadavků na wiki server si nejprve přečtěte stránky s přehledem, jako jsou formáty dat, chyby a varování a Action API FAQ.



Jak používat MediaWiki Action API
Můžete požádat o data ze strany klienta na server přes HTTP a získat odpověď zpět ve standardním formátu (obvykle JSON). Požadavek se skládá z koncového bodu a sady parametrů. Existují dva typy požadavků, které lze provést: GET a POST. U požadavku GET parametr v adrese URL obsahuje řetězec dotazu. U požadavku POST naformátujete parametry ve formátu JSON.



Formát požadavku
Všechny wikiny Wikimedie mají koncové body v tomto formátu. Chcete-li pracovat na hlavním webu MediaWiki nebo anglické Wikipedii, použijte související koncový bod. Například anglická Wikipedie. Pro testování nových účtů nebo testování úprav stránek použijte koncový bod testovací wiki.

Do řetězce dotazu v adrese URL přidejte parametr. Říká API, kterou akci má provést. Nejoblíbenější akcí je  (adresa URL by obsahovala ), což umožňuje načítání dat z wiki. Po parametru  přidejte další parametr, který označí, který ze tří typů modulu dotazu chcete provést:


 * - získá vlastnosti stránek
 * - získá seznam stránek odpovídajících určitému kritériu
 * - získá meta informace o wiki a o uživateli

Nakonec zahrňte parametr, který API říká, v jakém formátu má získat výsledky. Doporučený formát je JSON. API v minulosti podporovalo jiné výstupní formáty, ale obecně se nedoporučují.



Jednoduchý dotaz
Vezměme si příklad jednoduchého dotazu, abychom pochopili, jak by vypadal typický požadavek a odpověď GET v kontextu Action API.

Pojďme hledat název na wiki. Použijeme modul  zdokumentovaný na.



Dotazování přes GET
Chcete-li vyhledat názvy stránek nebo obsah odpovídající, bude adresa URL požadavku HTTP GET:Vysvětlení každé části adresy URL:


 * je hlavní koncový bod. V tomto případě je to anglická Wikipedie.
 * znamená načíst data z wiki.
 * znamená získat seznam stránek odpovídajících kritériím.
 * označuje název stránky nebo obsah, který se má hledat.  označuje znak mezery v adrese URL.
 * označuje výstup JSON, což je doporučený výstupní formát.

Odpověď
Odpovědí je dokument ve formátu JSON se seznamem názvů stránek, které odpovídají Craig Noone:



Příklady projektů využívajících Action API
Některé příklady projektů ve Wikimedii, které používají Action API:


 * Wikipedia iOS App, jehož jednou z funkcí je vyhledávání wiki stránek v blízkosti vaší polohy.
 * Roboti, kteří fungují na wiki. Pywikibot je robotický rámec napsaný v Pythonu, který je propojen s MediaWiki API, které používá mnoho vývojářů robotů.
 * Použití API při vizualizaci dat získaných z wiki. Jako je tato [úhledná vizualizace na http://listen.hatnote.com/], která ukazuje úpravy provedené na Wikipedii v reálném čase.



Další poznámky

 * Několik stránek používá MediaWiki. Všichni možná používají jinou verzi MediaWiki a zase API. Některé parametry modulu podporované v jedné verzi mohou být v jiných zastaralé nebo odstraněny. O tom byste se mohli dozvědět v dokumentaci každého modulu prostřednictvím API modulu nápovědy.
 * Pokud chcete provádět mnoho volání API a možná provozovat velmi zaneprázdněné a aktivní roboty, promluvte si předem s administrátory wiki, aby vás neblokovali. Viz seznam administrátorů projektů Wikimedie. Přečtěte si více o tomto tématu na.
 * Všechny akce upravující data, jako je protokolování, úprava nebo přesun stránky a sledování nebo hlídání změn, by vyžadovaly tokeny. Abyste mohli pokračovat, budete muset získat tokeny prostřednictvím.

Zdroje

 * Use Special:APISandbox to experiment with the Action API. You can play around with supported actions, specify a value for parameters, and send requests to the API to see the results on the same page.
 * Wikimedia dumps so you can work with them locally.
 * Read through tutorials: An Introduction to API's and What is REST — A Simple Explanation for Beginners.
 * MediaWiki API help provides auto-generated API documentation of all supported modules.
 * provides an overview of the Action API.
 * Introduction to the MediaWiki API by User:Roan_Kattouw_(WMF) at the San Francisco Hackathon, 2012. This tutorial guide goes along with the video.
 * GitHub: MediaWiki API Demos