Template:ApiEx/es

From mediawiki.org
Jump to navigation Jump to search
This page is a translated version of the page Template:ApiEx and the translation is 100% complete.
Other languages:
Deutsch • ‎English • ‎Nederlands • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎italiano • ‎magyar • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎svenska • ‎русский • ‎العربية • ‎فارسی • ‎বাংলা • ‎ไทย • ‎中文 • ‎日本語


Template documentation

Use esta plantilla en las páginas de documentación API para formatear una solicitud API de ejemplo.

Ten en cuenta que, como alternativa, {{Api help}} transcluye la documentación API localizada, generada desde código fuente que normalmente tiene ejemplos de API en él.

User:SPage (WMF)/ApiEx utility crea una invocación de plantilla {{ApiEx}} si pegas una URL api.php en ella.

Uso

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

Parámetros

  • desc - API Descripción de petición
  • lang - Código de dos letras para el lenguaje wiki. 'en' por defecto.
  • site - URL completa del sitio para usar en el ejemplo (por ejemplo, www.mediawiki.org). Invalida el parámetro lang.
  • p1-p9 - grupos de parámetros, cada uno contiene un param = valor par o varios pares, cada uno separado por un & (&), p.ej. p3=param=value&paramB=valueBbbb
  • 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
    | result=<syntaxhighlight lang="javascript">PASTE RESPONSE HERE</syntaxhighlight>
  • post - a "list" of {{ApiEx/Post}} objects, to generate a post table
  • collapse - set to "no" to stop "result" and "post" sections from being collapsed with {{Collapse top}}/{{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 | apisandbox=0 to not show this link.

Notas

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

Ejemplo

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

Resultado
Parámetros Post
Nombre de parámetro Valor por defecto Comentario
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>