Template:ApiEx/uk
Документація шаблону
Використовуйте цей шаблон на сторінках документації API, щоб відформатувати приклад запиту API.
Зверніть увагу, як альтернатива, {{Api help }} включає локалізовану документацію API, створену з вихідного коду, який зазвичай містить приклади API.
User:SPage (WMF)/ApiEx utility створює виклик шаблону {{ApiEx }}, якщо ви вставите в нього URL-адресу api.php.
Використання
{{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}} }}
Параметри
- desc — Опис запиту API
- lang — двобуквенний код для мови вікі. 'en' за замовчуванням.
- site — повна URL-адреса сайту для використання в прикладі (наприклад, www.mediawiki.org). Замінює параметр lang.
- p1-p9 — групи параметрів, кожна з яких містить одну пару param=value або кілька пар, кожна із яких розділена амперсандом (&), напр. p3=param=value¶mB=valueBbbb
- result — результат виконання запиту. Додайте шаблон, перегляньте його, натисніть посилання api.php, скопіюйте та вставте відповідь API у шаблон як | result=<syntaxhighlight lang="javascript">ВСТАВИТИ ВІДПОВІДЬ ТУТ</syntaxhighlight>
- post — «список» об'єктів {{ApiEx/Post }}, щоб створити таблицю публікацій
- collapse — встановити значення «no», щоб зупинити згортання розділів «результат» і «опублікування» за допомогою {{Collapse top }}/{{Collapse bottom }}
- apisandbox — чи показувати посилання «[try in ApiSandbox]», яке завантажує приклад параметрів запиту API в Special:ApiSandbox. За замовчуванням – 1, додайте | apisandbox=0, щоб не показувати це посилання.
Примітки
- Цей шаблон виводить посилання на вікітекст. Будь-які пробіли в параметрах URL-адреси
p1
...p9
спотворять посилання, тому змініть їх на%20
. - Аналогічно, будь-які значення, відокремлені вертикальними рядками в параметрах URL-адреси, наприклад, група сторінок «title1|title2», мають бути екрановані, тому використовуйте магічне слово
{{!}}
.
Приклад
Capitalization, localization, "_" => " ", "Project" => "Wikipedia", ...
Результат | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
<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>
|