Template:ApiEx/de

api.php? [In der ApiSandbox ausprobieren]

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. Füge die Vorlage hinzu, zeige eine Vorschau an, klicke auf den api.php-Link und kopiere die API-Antwort und füge sie als | result=<syntaxhighlight lang="javascript">PASTE RESPONSE HERE</syntaxhighlight> in die Vorlage ein.
• post — Eine "Liste" der {{ApiEx/Post }}-Objekte, um eine post-Tabelle zu generieren
• collapse — auf "no" gesetzt, damit die Abschnitte "result" und "post" nicht mit {{Collapse top }}/{{Collapse bottom }} zusammengeklappt werden
• apisandbox — ob ein "[try in ApiSandbox]"-Link angezeigt werden soll, der die Beispiel-API-Abfrageparameter in Special:ApiSandbox lädt. Standard ist 1, füge | apisandbox=0 hinzu, um diesen Link nicht anzuzeigen.

Anmerkungen

• Diese Vorlage gibt einen Wikitext-link aus. Alle Leerzeichen in den URL-Parametern p1...p9 verstümmeln den Link, also ändere sie in %20.
• Ebenso müssen alle Pipe-getrennten Werte in den URL-Parametern, wie z.B. eine Gruppe von Seiten "title1|title2", escaped werden, also verwende das Zauberwort {{!}}.

Beispiel

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

api.php?action=query&titles=Project:articleA|article_B [In der ApiSandbox ausprobieren]

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>

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