Template:ApiEx/fr

'''[https:///w/api.php? api.php ? ]'''

{{documentation|content=

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 {{tl|Api help}} 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 {{tl|ApiEx}} si vous placez une URL d'api.php à l'intérieur.

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). Ecrase le paramètre lang.
 * p1-p9 — groupes de pamaètres, chacun contenant soit un couple param=value ou plusieurs couples sépéré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
 * post — liste d'objets ApiEx/Post pour générer une table post
 * collapse — mettre à  pour empêcher les sections result et post d'être repliées avec Collapse top/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.

Exemple
}}