Template:ApiEx/fr

This page is a translated version of the page Template:ApiEx and the translation is 100% complete.

Documentation du modèle

Utilisez ce modèle dans les pages de documentation de l'API pour formater un exemple de requête à cette API.

Notez aussi comme alternative, que {{Aide sur l'API }} transclut la documentation traduite de l'API, générée à partir du code source devant normalement contenir des exemples à l'intérieur.

User:SPage (WMF)/ApiEx utility fait appel au modèle {{ApiEx }} si vous placez une URL api.php à l'intérieur.

Utilisation

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

Paramètres

desc — description de la requête à l'API
lang — code à deux lettres représentant la langue du wiki. 'en' par défaut.
site — URL complète du site à utiliser dans l'exemple (comme www.mediawiki.org). Supplante le paramètre lang.
p1-p9 — groupes de pamètres, chacun contenant soit un couple param=value ou plusieurs couples séparés chacun par un ET commercial (&), comme : p3=param=value&paramB=valueBbbb
result — résultat d'exécution de la requête. Ajoutez le modèle, affichez l'aperçu, cliquez sur le lien api.php, et recopiez la réponse de l'API à l'intérieur du modèle, dans la partie | result=<syntaxhighlight lang="javascript">PASTE RESPONSE HERE</syntaxhighlight>
post — liste d'objets {{ApiEx/Post }} pour générer une table post
collapse — mettre à no pour empêcher les sections result et post d'être repliées avec {{Pliage début }}/{{Collapse bottom }}
apisandbox — indique s'il faut afficher un lien [try in ApiSandbox] pour charger les paramètres d'exemple de requête à l'API dans Special:ApiSandbox. Valeur par défaut : 1 ; ajoutez | apisandbox=0 pour ne pas faire apparaître ce lien.

Notes

Ce modèle génère un lien wikicode. Tout espace présent dans les paramètres p1...p9 de l'URL va perturber ce lien, donc transformez-les en %20.
De manière similaire, les valeurs dans les paramètres d'URLS tels que les groupes de pages title1|title2, séparées par des barres verticales, doivent être échappées; utilisez-alors le mot magique {{!}}.

Exemple

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

api.php?action=query&titles=Project:articleA|article_B [Essayez !]

Résultat

Nom du paramètre	Valeur	Valeur par défaut	Commentaire
Paramètres post
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>