Template:ApiEx/he

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

תיעוד תבנית

השתמש בתבנית זו בדפי התיעוד של 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 — כתובת האתר המלאה לשימוש בדוגמה (למשל, www.mediawiki.org). עוקף את הפרמטר lang.
p1-p9 — קבוצות פרמטרים, שכל אחת מכילה זוג אחד של param=value או זוגות מרובים שכל אחד מהם מופרד על ידי סימן אמפרסנד (&), לדוגמה. p3=param=value&paramB=valueBbbb
result — תוצאת ביצוע השאילתה. הוסף את התבנית, הצג תצוגה מקדימה, לחץ על הקישור api.php, והעתק והדבק את תגובת ה-API לתוך התבנית כ- | result=<syntaxhighlight lang="javascript">הדבק תגובה כאן</syntaxhighlight>
post — "list" רשימה של אובייקטים בגודל {{ApiEx/Post }}, כדי ליצור טבלת post
collapse — הגדר ל-"no" כדי למנוע את צמצום הסעיפים "result" ו-"post" עם {{Collapse top }}/{{Collapse bottom }}
apisandbox — האם להציג קישור "[try in ApiSandbox]" שטוען את פרמטרי שאילתת ה-API לדוגמה לתוך Special:ApiSandbox. ברירת המחדל היא 1, הוסף | apisandbox=0 ל-not כדי להציג קישור זה.

הערות

תבנית זו מפיקה קישור ויקיטקסט. כל רווח בפרמטרי ה-URL p1...p9 יגרום לקישור להיות מעוות, לכן שנה אותם ל-%20.
באופן דומה, כל ערך המופרד באמצעות תווים קצרים בפרמטרי ה-URL, כגון קבוצת דפים "title1|title2", חייב להיות מבוטל, לכן השתמשו במילת הקסם {{!}}.

דוגמה

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

api.php?action=query&titles=Project:articleA|article_B [להתנסות ב- ApiSandbox]

תוצאה

שם פרמטר	ערך	ברירת מחדל	הערה
פרמטרים של 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>