Senik: 1 версия импортирована

2020-02-25T12:42:32Z

1 версия импортирована

Template>Shirayuki: Marked this version for translation

2020-01-17T13:36:51Z

Marked this version for translation

Новая страница

<noinclude>
<languages/>
</noinclude>{{#switch:<translate></translate>
| =
{{{desc|}}}
<div class="plainlinks" style="margin-bottom: 0.3em">'''[https://{{{site|{{{lang|en}}}.wikipedia.org}}}/w/api.php?{{{p1|}}}{{#if:{{{p2|}}}|&{{{p2}}}}}{{#if:{{{p3|}}}|&{{{p3}}}}}{{#if:{{{p4|}}}|&{{{p4}}}}}{{#if:{{{p5|}}}|&{{{p5}}}}}{{#if:{{{p6|}}}|&{{{p6}}}}}{{#if:{{{p7|}}}|&{{{p7}}}}}{{#if:{{{p8|}}}|&{{{p8}}}}}{{#if:{{{p9|}}}|&{{{p9}}}}} api.php?{{{p1|}}}{{#if:{{{p2|}}}|&{{{p2}}}}}{{#if:{{{p3|}}}|&{{{p3}}}}}{{#if:{{{p4|}}}|&{{{p4}}}}}{{#if:{{{p5|}}}|&{{{p5}}}}}{{#if:{{{p6|}}}|&{{{p6}}}}}{{#if:{{{p7|}}}|&{{{p7}}}}}{{#if:{{{p8|}}}|&{{{p8}}}}}{{#if:{{{p9|}}}|&{{{p9}}}}}]'''{{#ifeq:{{{apisandbox|1}}}| 1 | [https://{{{site|{{{lang|en}}}.wikipedia.org}}}/wiki/Special:ApiSandbox#{{{p1|}}}{{#if:{{{p2|}}}|&{{{p2}}}}}{{#if:{{{p3|}}}|&{{{p3}}}}}{{#if:{{{p4|}}}|&{{{p4}}}}}{{#if:{{{p5|}}}|&{{{p5}}}}}{{#if:{{{p6|}}}|&{{{p6}}}}}{{#if:{{{p7|}}}|&{{{p7}}}}}{{#if:{{{p8|}}}|&{{{p8}}}}}{{#if:{{{p9|}}}|&{{{p9}}}}} [<translate> try in ApiSandbox</translate>]]}}</div>{{#if:{{{post|}}}|{{#ifeq:{{{collapse|}}}|no||{{collapse top|<translate> Result</translate>}}}}
<table style="text-align:{{dir|{{pagelang}}|right|left}}; width:100%; margin:0.5em 0.2em; border-{{dir|{{pagelang}}|right|left}}:3px solid red">
<tr>
<td colspan="4" style="font-weight: bold; border-bottom: 1px solid gray;"><translate> Post parameters</translate></td>
</tr><tr style="font-weight: bolder;">
<th style="width: 20%;"><translate> Parameter name</translate></th>
<th style="width: 20%;"><translate> Value</translate></th>
<th style="width: 20%;"><translate> Default</translate></th>
<th style="width: 40%;"><translate> Comment</translate></th>
</tr>
{{{post|}}}
</table>
|{{#if:{{{result|}}}|{{#ifeq:{{{collapse|}}}|no||{{collapse top|<translate> Result</translate>|extrastyle=overflow:auto;}}}}}}
}}
{{{result|}}}
{{#if:{{{result|}}}{{{post|}}}|{{#ifeq:{{{collapse|}}}|no||{{collapse bottom }}}}}}
| #default=
{{#invoke:Template translation|renderTranslatedTemplate|template=Template:ApiEx|noshift=1}}
}}<noinclude>
{{documentation|content=

<translate>

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


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


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

== Usage == 
</translate>
<pre><nowiki>
{{ApiEx
| desc=Capitalization, localization, "_" => " ", "Project" => "Wikipedia", ...
| p1=action=query
| p2=titles=Project:articleA{{!}}article_B
| result=<source 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>
</source>
| post={{ApiEx/Post|parameter=days|value=integer|default=7|comment=comment}}
}}
</nowiki></pre>

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

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

<translate>
== Example == 
</translate>
{{ApiEx
| desc=Capitalization, localization, "_" => " ", "Project" => "Wikipedia", ...
| p1=action=query
| p2=titles=Project:articleA{{!}}article_B
| result=<source 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>
</source>
| post={{ApiEx/Post|parameter=days|value=integer|default=7|comment=comment}}
}}

}}
[[Category:API templates{{#translation:}}]]
</noinclude>

← Предыдущая	Версия 12:42, 25 февраля 2020
(нет различий)

Шаблон:ApiEx - История изменений

Senik: 1 версия импортирована

Template>Shirayuki: Marked this version for translation