API:FAQ/cs

Přehled

Tato stránka poskytuje odpovědi na některé často kladené otázky týkající se MediaWiki Action API. Tato stránka je určena pro technické přispěvatele a vývojáře softwaru, kteří chtějí porozumět a používat MediaWiki Action API.

Přečtěte si také příspěvek od API:Main page . Odpovídá na některé otázky, které zde nebyly zodpovězeny, a odkazuje na další užitečné stránky.

O API

Co je API?

API je zkratka pro Application Programming Interface (rozhraní pro programování aplikací). Umožňuje různým aplikacím vzájemně komunikovat. API někdy umožňuje aplikaci požádat o provedení akce aplikací, která API implementuje. V obecné rovině mediawiki se tím označují webové API, která používají mechanismus HTTP požadavků a odpovědí a produkují strukturovaná data JSON/XML.

Co je REST API?

REST je zkratka pro REpresentational State Transfer (přenos reprezentačního stavu). Soubor hlavních principů nebo omezení definuje RESTful systém. RESTful API – nebo jen REST API – se řídí těmito principy, a proto je rychlejší, spolehlivější a škálovatelnější službou.

Co umí API?

Viz některá použití API.

Kde se mohu dozvědět více o API?

Zde je několik zdrojů:

• w:Web APIs - porozumnění API
• Úvod do API
• w:REST - REST (Převod reprezentativního stavu) API

Obecné

Co je API akcí MediaWiki?

Rozhraní API akcí MediaWiki je REST úplná webová služba, která umožňuje uživatelům provádět určité akce na wiki, jako je vytváření stránek, ověřování, parsování, vyhledávání atd.

K čemu lze použít rozhraní MediaWiki Action API?

Rozhraní MediaWiki Action API lze použít k:

• Přístup k funkcím wiki.
• Vzájemně působit s wiki.
• Získat metainformace o wiki a veřejných uživatelích.

Pravý postranní panel ukazuje mnoho funkcí podporovaných API. Podívejte se také na některé projekty Wikimedie, které používají MediaWiki Action API.

Jak mohu použít (nebo zavolat) API akce MediaWiki?

HTTP požadavky se obvykle používají k volání Action API. Podrobné pokyny naleznete v návodu.

Jak si pohrát s Action API:

• Použijte Special:ApiSandbox.
• Povolte konzoli pro vývojáře ve vašem prohlížeči a sledujte síťové požadavky na api.php při interakci s wiki.

Co je modul, submodul a parametr?

API akcí MediaWiki má řadu modulů, které používáme k provádění různých úkolů. Technicky vzato je modul podtřídou třídy ApiBase. Modul vyžaduje parametry. Tyto parametry mohou (ale nemusí) být podmoduly.

Zvažte následující požadavek:

api.php?action=query&list=search&srsearch=abc&format=json [zkuste v ApiSandbox]

zde:

• action je parametr hlavního modulu.
• action=query je další modul. Nazývá se modul dotazu.
• list je parametr modulu dotazu.
• list=search je také modul. Lze jej nazvat submodulem modulu action=query.
• srsearch je parametr vyhledávacího modulu Special:MyLanguage/API:Search. Obsahuje hledaný řetězec 'abc'.
• format je parametr hlavního modulu.
• Výstupní formát je json.

Viz také Úvod a pokyny. Popisuje podmoduly modulu action=query .

Jak zjistím, který modul a submodul mám volat?

MediaWiki Action API je velké a rozšíření jej dále rozšiřují. Zde je několik způsobů, jak vyřešit váš požadavek na API:

• V postranním panelu vyhledejte funkci, kterou chcete implementovat, a klikněte na odkaz s informacemi o tom, které moduly volat.
• Stránky samodokumentující API obsahují seznam všech modulů a submodulů se stručnými popisy. Můžete začít na hlavním modulu a sledovat odkazy na různé submoduly. (Přidejte recursivesubmodules=1 pro zobrazení rozšířené verze)

Kde najdu ukázkové kódy pro použití modulů API?

Stránky Dokumentace API obsahují sekci 'Příklady', která demonstruje použití různých modulů a submodulů. automaticky generovaná dokumentace také obsahuje příklady za popisy modulů.

Úryvky kódu v Pythonu a JavaScriptu naleznete v Mediawiki-API-demas.

Jak mohu ovládat výstupní formát?

Výchozí výstupní formát je JSON. Ostatní výstupní formáty byly v nejnovější stabilní verzi MediaWiki zastaralé nebo odstraněny a jejich používání se nedoporučuje.

Ve starších verzích můžete pro řízení výstupního formátu předat do řetězce dotazu hodnotu &format=someformat.

Informace naleznete na stránce API:Datové formáty.

Potřebuji přístupový token?

Pro provádění akcí úpravy dat, jako je přihlašování, úpravy, přesouvání stránek atd., budete potřebovat přístupový token.

Chcete-li se dozvědět více, podívejte se na stránku API:Tokeny nebo na kategorii postranního panelu 'Ověřování'.

Jak mohu pomocí API vytvářet požadavky napříč weby?

Pro vytváření požadavků napříč weby v MediaWiki musíte použít JSONP nebo CORS.

Podrobnosti naleznete na stránce API:Požadavky napříč weby.

Existuje nějaký limit výsledků dotazu?

Ano, záleží na parametru dotazu. Například výsledky pro dotazy list a property nesmí pro běžné uživatele překročit 500. Informace o těchto limitech naleznete na stránkách API v části 'Další poznámky' nebo 'Limity'. Upozorňujeme, že některé moduly za určitých podmínek ukládají přísnější limity.

Pokud si nejste jisti, jaký limit nastavit, a chcete jen co nejvíce výsledků, nastavte limit na max.

Existuje omezení volání API?

Since 2026, per-user rate limits have been in place to avoid overloading the infrastructure. Pokud chcete provést mnoho požadavků, kontaktujte administrátory předem.

Viz také stránka API:Etiketa.

Kde mohu získat aktualizace o rozhraní MediaWiki Action API?

Můžete se přihlásit k odběru mailing listu MediaWiki-API-Announce a dostávat oznámení a aktualizace.

Co jsou to wiki dumpy a jak s nimi mohu pracovat?

Datové výpisy Wikimedia jsou výpisy wiki kolekcí, obsahu, metadat, vyhledávacích indexů atd. Pro práci s výpisy se podívejte na používání výpisů a veřejné výpisy.

Kde mohu získat další pomoc?

Pokud nenajdete odpovědi v Dokumentaci k MediaWiki API nebo na stránkách automaticky generované dokumentace, neváhejte se na nás obrátit následujícími způsoby.

• Vytvořte si účet Wikimedia (pokud ho ještě nemáte) a přidejte nové téma na diskusní stránce API.
• Položte svou otázku na:
  • IRC v kanálu #mediawiki ^{připojit se}.
  • Mailing list MediaWiki-API

Vývojáři rozšíření a vlastníci wiki

Jak mohu vytvořit API modul v rozšíření?

API:Rozšíření vás provede celým procesem vytvoření API modulu v rozšíření.

Jaká je vnitřní struktura API?

API:Implementační strategie vysvětluje implementaci API mechanismů v jádru MediaWiki.

Jak mohu omezit používání API?

Chcete-li omezit používání API, můžete buď omezit používání API pro zápis, nebo zakázat jednotlivé moduly.

Pokyny a příklady naleznete v části API:Omezení používání API.

Chyby a řešení problémů

Jak zjistím chybu?

Pokud narazíte na chybu, chybová odpověď z API nastaví HTTP hlavičku MediaWiki-API-Error a vrátí struktura chyby.

Co tato chyba znamená?

Najděte svou chybu v seznamu standardních chybových zpráv, abyste pochopili, co chyba znamená.

Jak mohu podat žádost o chybu/funkci?

Chyby a požadavky na nové funkce můžete hlásit v nástroji pro sledování úkolů Wikimedie, Pharbacator.

Poznámka:

• Přidejte do svého úkolu tag projektu MediaWiki-API.
• Pokud je vaše zpráva/požadavek nabízen rozšířením, přidejte projekt tohoto rozšíření. (např. MediaWiki-extensions-AbuseFilter, MediaWiki-extensions-FlaggedRevs atd.)
• Před vytvořením nového úkolu ověřte duplikáty.
• Před pokračováním si prostudujte podmínky vytváření úkolů na Phabricatoru.

Více informací naleznete v článku Jak nahlásit chybu.

Mám problémy s verzí API?

Pokud webová stránka používá jinou verzi MediaWiki, bude také používat jinou verzi API. Některé parametry modulů podporované v jedné verzi mohou být v jiných zastaralé (nebo odstraněné). Pokud se takové parametry použijí, vyvolá to výjimku. Veškeré takové zastaralé parametry jsou popsány na stránkách API.

Informace o různých verzích API naleznete v poznámkách k verzi.