Template:ApiEx/pl

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

Dokumentacja szablonu

Użyj tego szablonu na stronach dokumentacji API, aby sformatować przykładowe żądanie API.

Uwaga jako alternatywa, {{Api help }} obejmuje lokalizowaną dokumentację API generowaną z kodu źródłowego, w którym zazwyczaj znajdują się przykłady API.

User:SPage (WMF)/ApiEx utility tworzy włączenie szablonu {{ApiEx }} jeśli wklejesz do niego adres URL api.php.

Użycie

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

Parametry

desc — Opis żądania API
lang — dwuliterowy kod dla języka wiki. 'en' domyślnie.
site — pełny adres URL strony do użycia w przykładzie (np. www.mediawiki.org). Odwołuje parametr na lang.
p1-p9 — grupy parametrów, z których każda zawiera jedną parę param=wartości lub wiele par, każda oddzielona ampersandem (&), np. p3=param=value&paramB=valueBbbb
result — wynik wykonania zapytania. Dodaj szablon, wyświetl podgląd, kliknij link api.php, a następnie skopiuj i wklej odpowiedź API do szablonu jako | result=<syntaxhighlight lang="javascript">PASTE RESPONSE HERE</syntaxhighlight>.
post — "lista" obiektów {{ApiEx/Post }} do generowania tabeli postów
collapse — ustawione na "no" aby powstrzymać sekcje "rezultat" i "post" od załamania z {{Collapse top }}/{{Collapse bottom }}
apisandbox — czy wyświetlić link "[try in ApiSandbox]" w którym parametry zapytania API są załadowane do Special:ApiSandbox. Domyślnie jest to 1, dodaj | apisandbox=0, aby nie pokazywać tego linku.

Uwagi

Ten szablon wychodzi z linku wikitekstu. Wszelkie przestrzenie w parametrach URL p1...p9 zablokować będzie link, więc zmienić je na %20.
Podobnie, każde dane oddzielne od rury w parametrach URL, takie jak grupa stron "title1|title2" muszą zostać uniknięte, więc użyj magicznego słowa {{!}}.

Przykład

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

api.php?action=query&titles=Project:articleA|article_B [wypróbuj w ApiSandbox]

Wynik

Nazwa parametru	Wartość	Domyślnie	Komentarz
Parametry 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>