Template:ApiEx/cs
Appearance
Template documentation
Použijte tuto šablonu na stránkách dokumentace API k formátování vzorového požadavku API.
Všimněte si, že jako alternativa {{Api help }} zahrnuje lokalizovanou dokumentaci API generovanou ze zdrojového kódu, který normálně obsahuje příklady API.
User:SPage (WMF)/ApiEx utility vytvoří vyvolání šablony {{ApiEx }}, pokud do něj vložíte adresu URL api.php.
Použití
{{ApiEx | desc=Capitalization, localization, "_" => " ", "Project" => "Wikipedia", ... | p1=action=query | p2=titles=Project:articleA{{!}}article_B | result=<syntaxhighlight lang="xml"> <api> <query> <normalized> <n from="Project:articleA" to="Wikipedia:ArticleA" /> <n from="article_B" to="Article B" /> </normalized> <pages> <page ns="4" title="Wikipedia:ArticleA" missing="" /> <page ns="0" title="Article B" missing="" /> </pages> </query> </api> </syntaxhighlight> | post={{ApiEx/Post|parameter=days|value=integer|default=7|comment=comment}} }}
Parametry
- desc — popis požadavku API.
- lang — dvě písmena kódu pro jazyk wiki. Ve výchozím nastavení 'en'.
- site — úplná URL adresa webu, který se má použít v příkladu (např. www.mediawiki.org). Přepíše parametr lang.
- p1-p9 — skupiny parametrů, z nichž každá obsahuje buď jeden pár param=hodnota, nebo více párů, z nichž každý je oddělen znakem ampersand (&), např. p3=param=value¶mB=valueBbbb
- result — výsledek provedení dotazu. Přidejte šablonu, zobrazte náhled, klikněte na odkaz api.php a zkopírujte a vložte odpověď API do šablony jako | result=<syntaxhighlight lang="javascript">VLOŽTE ODPOVĚĎ SEM</syntaxhighlight>
- post — "seznam" {{ApiEx/Post }} objektů pro vytvoření tabulky příspěvků
- collapse — nastavte na "no", abyste zabránili sbalení sekcí "result" (výsledek) a "post" (příspěvek) v {{Collapse top }}/{{Collapse bottom }}
- apisandbox — zda zobrazit odkaz "[try in ApiSandbox]", který načte vzorové parametry dotazu API do Special:ApiSandbox. Výchozí hodnota je 1, přidejte | apisandbox=0 k nezobrazovat tento odkaz.
Poznámky
- Tato šablona vytváří wikitextový odkaz. Jakékoli mezery v parametrech URL
p1
...p9
zkomolí odkaz, takže je změňte na%20
. - Podobně všechny hodnoty oddělené svislou čarou v parametrech adresy URL, jako je skupina stránek "title1|title2", musí být escapovány, takže použijte kouzelné slovo
{{!}}
.
Příklad
Capitalization, localization, "_" => " ", "Project" => "Wikipedia", ...
Výsledek | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
<api>
<query>
<normalized>
<n from="Project:articleA" to="Wikipedia:ArticleA" />
<n from="article_B" to="Article B" />
</normalized>
<pages>
<page ns="4" title="Wikipedia:ArticleA" missing="" />
<page ns="0" title="Article B" missing="" />
</pages>
</query>
</api>
|