NepenthesOdyssey: 1 revision imported

2025-02-25T09:37:02Z

1 revision imported

New page

<noinclude>
<languages/>
</noinclude>{{#if:{{{desc|}}}|<div>{{{desc}}}</div>}}<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<span style="margin:0 0.5em">?</span><wbr />{{{p1|}}}{{#if:{{{p2|}}}|<span style="margin:0 0.5em">&</span><wbr />{{{p2}}}}}{{#if:{{{p3|}}}|<span style="margin:0 0.5em">&</span><wbr />{{{p3}}}}}{{#if:{{{p4|}}}|<span style="margin:0 0.5em">&</span><wbr />{{{p4}}}}}{{#if:{{{p5|}}}|<span style="margin:0 0.5em">&</span><wbr />{{{p5}}}}}{{#if:{{{p6|}}}|<span style="margin:0 0.5em">&</span><wbr />{{{p6}}}}}{{#if:{{{p7|}}}|<span style="margin:0 0.5em">&</span><wbr />{{{p7}}}}}{{#if:{{{p8|}}}|<span style="margin:0 0.5em">&</span><wbr />{{{p8}}}}}{{#if:{{{p9|}}}|<span style="margin:0 0.5em">&</span><wbr />{{{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|1=<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|1=<translate> Result</translate>|extrastyle=overflow:auto;}}}}}}
}}{{#if:{{{result|}}}|<div>{{{result}}}</div>}}{{#if:{{{result|}}}{{{post|}}}|{{#ifeq:{{{collapse|}}}|no||{{collapse bottom }}}}}}<noinclude>
{{documentation|content=

<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>{{tl|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>{{tl|ApiEx}}</tvar> 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=<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}}
}}
</nowiki></pre>

<translate>
== 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> <kbd>p3=param=value&paramB=valueBbbb</kbd>
* 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=<kbd>{{!}} result=<syntaxhighlight lang="javascript">$1</syntaxhighlight></kbd></tvar>|''PASTE RESPONSE HERE''}}</translate>
* post — <translate> a "list" of <tvar name=1>{{tl|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>{{tl|Collapse top}}/{{tl|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><kbd><nowiki>| apisandbox=0</nowiki></kbd></tvar> to ''not'' show this link.</translate>

<translate>
== Notes == 
</translate>
* <translate> This template outputs a wikitext link.</translate> <translate> Any spaces in the URL parameters <tvar name=1><code>p1</code>...<code>p9</code></tvar> will garble the link, so change them to <tvar name=2><code>%20</code></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><code><nowiki>{{!}}</nowiki></code></tvar> magic word.</translate>

<translate>
== Example == 
</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}}
}}
}}
[[Category:API templates{{#translation:}}]]
</noinclude>

Template:ApiEx - Revision history

NepenthesOdyssey: 1 revision imported