Template:ApiEx/de

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


Vorlagendokumentation

Nutze diese Vorlage auf API-Dokumentationsseiten, um eine Beispiel-API-Abfrage zu formatieren.

Beachte, dass {{Api help}} als Alternative die lokalisierte API-Dokumentation einbindet, die aus dem Quellcode generiert wird, in welchem sich normalerweise API-Beispiele befinden.

User:SPage (WMF)/ApiEx utility erstellt eine {{ApiEx}}-Vorlageneinbindung, wenn du eine api.php-URL einfügst.

Benutzung

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

Parameter

  • desc — Beschreibung der API-Abfrage
  • lang — Zweibuchstabiger Code für die Sprache des Wikis. Standardmäßig 'en'.
  • site — Vollständige URL der Seite, die in dem Beispiel genutzt wird (z.B. www.mediawiki.org). Überschreibt den Parameter lang.
  • p1-p9 — Parametergruppen, jede enthält entweder ein param=value-Paar oder mehrere Paare, die jeweils durch das Und-Zeichen (&) getrennt sind, z.B. p3=param=value&paramB=valueBbbb
  • result — Das Ergebnis der Abfragenausführung. 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 — Eine "Liste" der {{ApiEx/Post}}-Objekte, um eine post-Tabelle zu generieren
  • 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. Standard ist 1, füge | apisandbox=0 hinzu, um diesen Link nicht anzuzeigen.

Anmerkungen

  • Diese Vorlage gibt einen Wikitext-link aus. 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.

Beispiel

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

Ergebnis
Parameter posten
Parametername Wert Standard Anmerkung
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>