Template:ApiEx/nl

api.php? [probeer het in de ApiSandbox]

Template documentation

Gebruik dit sjabloon op de API documentatie pagina's om een voorbeeld van een API request te formatteren.

Een alternatief is dat {{Api help }} gelokaliseerde API documentatie uit de broncode haalt die normaal gesproken voorbeelden van API's bevat.

User:SPage (WMF)/ApiEx utility maakt een aanroep van sjabloon {{ApiEx }} aan, als u er een api.php URL in zet.

Gebruik

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

• desc — API request beschrijving
• lang — code van twee letters voor de taal van de wiki. 'en' is de standaardwaarde.
• site — volledige URL van de website die in het voorbeeld moet worden gebruikt (bijv., www.mediawiki.org). Overschrijft de parameter lang.
• p1-p9 — parametergroepen, elk bevattende een param=value paar of meerdere paren elk gescheiden door een ampersand (&), bijv. p3=param=value&paramB=valueBbbb
• result — het resultaat van het uitvoeren van de query. Voeg het sjabloon toe, voorvertoon het, klik op de link api.php, en kopieer en plak de API response in het sjabloon als | result=<syntaxhighlight lang="javascript">PASTE RESPONSE HERE</syntaxhighlight>
• post — een "lijst" van {{ApiEx/Post }} objecten, om een post tabel te genereren
• collapse — zet op "no" om het inklappen van de secties "resultaat" en "post" met {{Collapse top/nl }}/{{Collapse bottom }} te stoppen
• apisandbox — of er een link "[try in ApiSandbox]" moet worden getoond waarmee de voorbeeld parameters van de API-query in Special:ApiSandbox geladen kunnen worden. Standaardwaarde is 1, voeg | apisandbox=0 toe om de link niet te tonen.

Notities

• Dit sjabloon geeft als uitvoer een wikitext link. De spaties in de URL parameters p1...p9 zouden de link verstoren, dus die worden gewijzigd naar %20.
• Op dezelfde manier moet elke met een verticale streep gescheiden waarde in de URL parameters worden behandeld (escaped), gebruik dus het magische woord {{!}}.

Voorbeeld

Capitalization, localization, "_" => " ", "Project" => "Wikipedia", ...

api.php?action=query&titles=Project:articleA|article_B [probeer het in de ApiSandbox]

Resultaat
Post Parameters Parameternaam Waarde Standaard Opmerking days integer 7 comment <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>

Editors can experiment in this template’s sandbox (create | mirror) and testcases (create) pages.
Subpages of this template.