Шаблон:ApiEx

api.php? [<translate> try in ApiSandbox</translate>]

Для использования в TemplateStyles у страницы Модуль:Documentation/styles.css должна быть модель содержания "Sanitized CSS" (текущая модель: "обычный текст").

Template documentation

<translate> Use this template on [[<tvar name=1>Special:MyLanguage/API:Main page</tvar>|API]] documentation pages to format an example API request.

Note as an alternative, <tvar name=1>{{Api help}}</tvar> transcludes localized API documentation generated from source code which normally has API examples in it.

<tvar name=1>User:SPage (WMF)/ApiEx utility</tvar> creates a <tvar name=2>{{ApiEx}}</tvar> template invocation if you paste an api.php URL into it.

Usage

</translate>

{{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}}
}}

Parameters

</translate>

desc — <translate> API request description</translate>
lang — <translate> two-letter code for the wiki language.</translate> <translate> <tvar name=1>'en'</tvar> by default.</translate>
site — <translate> full URL of site to use in example (e.g., <tvar name=1>www.mediawiki.org</tvar>).</translate> <translate> Overrides <tvar name=1>lang</tvar> parameter.</translate>
p1-p9 — <translate> parameter groups, each containing either one param=value pair or multiple pairs each separated by an ampersand (<tvar name=1>&</tvar>), e.g.</translate> p3=param=value&paramB=valueBbbb
result — <translate> the result of the query execution.</translate> <translate> Add the template, preview, click the <tvar name=1>api.php</tvar> link, and copy and paste the API response into the template as {{<tvar name=2>tmpl|0=| result=<syntaxhighlight lang="javascript">$1</syntaxhighlight></tvar>|PASTE RESPONSE HERE}}</translate>
post — <translate> a "list" of <tvar name=1>{{ApiEx/Post}}</tvar> objects, to generate a post table</translate>
collapse — <translate> set to "<tvar name=1>no</tvar>" to stop "result" and "post" sections from being collapsed with <tvar name=2>{{Collapse top}}/{{Collapse bottom}}</tvar></translate>
apisandbox — <translate> whether to show a "<tvar name=1>[try in ApiSandbox]</tvar>" link that loads the example API query parameters into <tvar name=2>Special:ApiSandbox</tvar>.</translate> <translate> Default is <tvar name=1>1</tvar>, add <tvar name=2>| apisandbox=0</tvar> to not show this link.</translate>

Notes

</translate>

<translate> This template outputs a wikitext link.</translate> <translate> Any spaces in the URL parameters <tvar name=1>p1...p9</tvar> will garble the link, so change them to <tvar name=2>%20</tvar>.</translate>
<translate> Similarly, any pipe-separate values in the URL parameters such as a group of pages "<tvar name=1>title1|title2</tvar>" must be escaped, so use the <tvar name=2>{{!}}</tvar> magic word.</translate>

Example

</translate> Capitalization, localization, "_" => " ", "Project" => "Wikipedia", ...

api.php?action=query&titles=Project:articleA|article_B [<translate> try in ApiSandbox</translate>]

Шаблон:Collapse top Шаблон:ApiEx/Post

<translate> Parameter name</translate>	<translate> Value</translate>	<translate> Default</translate>	<translate> Comment</translate>
<translate> Post parameters</translate>

<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>

Шаблон:Collapse bottom

Editors can experiment in this template's sandbox and testcases pages.
Subpages of this template.

[[Category:API templates{{#translation:}}]]