Template:ApiEx/ar

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


توثيق القالب

استخدم هذا القالب على صفحات توثيق واجهة برمجة التطبيقات كي تحصل على هيئة مثال على طلب واجهة برمجة التطبيقات.

لاحظ أنه يوجد بديل، وهو أن {{Api help}} تستخلص من توثيق واجهة برمجة التطبيقات المؤقلمة التي ولدت من النص المصدر الذي يحتوي عادة على أمثلة واجهة برمجة التطبيقات فيه.

User:SPage (WMF)/ApiEx utility تستحدث طلب قالب {{ApiEx}} لو لصقت معرف موارد موحد 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 — بيان طلب واجهة برمجة التطبيقات
  • lang — كود من حرفين يشير إلى لغة موقع الويكي. 'en' بصفة افتراضية.
  • site — معرف الموارد الموحد الكامل للموقع الذي سيستخدم في المثال (على سبيل المثال www.mediawiki.org). يتخطى المعامل lang.
  • p1-p9 — مجموعات معاملات، تحتوي كل منها سواء على معامل واحد=زوجين من القيم أو عدة أزواج يفصل كل منها علامة الضم (&) مثال ذلك p3=param=value&paramB=valueBbbb
  • result — نتيجة تنفيذ الاستعلام. أضف القالب واستعرضه وانقر على وصلة api.php وانسخ رد واجهة برمجة التطبيقات وألصقه في القالب في صفة | result=<syntaxhighlight lang="javascript">PASTE RESPONSE HERE</syntaxhighlight>
  • post — «قائمة» بنود {{ApiEx/Post}}، الغرض منها توليد جدول post
  • collapse — تضبط القيمة إلى «no» لمنع قسميّ «result» و «post» من أن يطويا باستخدام {{Collapse top}}/{{Collapse bottom}}
  • apisandbox — ما إذا كان يجب عرض وصلة «[try in ApiSandbox]» تحمّل متغيرات مثال استعلام واجهة برمجة التطبيقات في Special:ApiSandbox. القيمة الافتراضية هي 1، أضف | apisandbox=0 بغرض عدم عرض هذه الوصلة.

ملاحظات

  • مخرجات هذا القالب هي وصلة شبكية في صيغة نص ويكي. سوف ينتج عن أية مسافات في متغيرات معرف الموارد الموحد p1...p9 تحريف الوصلة، لذا غيّر هذه المسافات إلى %20.
  • شبيه بذلك، يتعين تفويت أية قيم مفصولة باستخدام الشريط العمودي في متغيرات معرف الموارد الموحد مثل مجموعات الصفحات «title1|title2»، لذلك استخدام بدلًا منها الكلمة السحرية {{!}}.

مثال

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

النتيجة
متغيرات لاحقة
اسم المتغير قيمة افتراضي تعليقات
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>