Template:ApiEx/tr
Şablon belgelemesi
Örnek bir API isteğini biçimlendirmek için bu şablonu API belge sayfalarında kullanın.
Alternatif olarak, {{Api help }}, normalde içinde API örnekleri bulunan kaynak koddan oluşturulan yerelleştirilmiş API belgelerini yansıtıldığını unutmayın.
İçine bir api.php URL'si yapıştırırsanız, User:SPage (WMF)/ApiEx utility, {{ApiEx }} şablon çağrısı oluşturur.
Kullanım
{{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}} }}
Parametreler
- desc — API istek açıklaması
- lang — viki dili için iki harfli kod. Varsayılan olarak 'en'.
- site — örnek olarak kullanılacak sitenin tam URL'si (ör. www.mediawiki.org). lang parametresini geçersiz kılar.
- p1-p9 — her biri bir param=değer çifti veya her biri ve işareti (&) ile ayrılmış birden çok çift içeren parametre grupları, ör. p3=param=value¶mB=valueBbbb
- result — sorgu yürütmenin sonucu. Şablonu ekleyin, önizleyin, api.php bağlantısını tıklayın ve API yanıtını kopyalayıp şablona | result=<syntaxhighlight lang="javascript">YANITI BURAYA YAPIŞTIRIN</syntaxhighlight> olarak yapıştırın.
- post — bir gönderi tablosu oluşturmak için {{ApiEx/Post }} nesnelerinin bir "listesi"
- collapse — "sonuç" ve "gönderme" bölümlerinin {{Collapse top }}/{{Collapse bottom }} ile daraltılmasını durdurmak için "no" olarak ayarlayın
- apisandbox — örnek API sorgu parametrelerini Special:ApiSandbox ile yükleyen bir "[try in ApiSandbox]" bağlantısının gösterilip gösterilmeyeceği. Varsayılan 1 değeridir, bu bağlantıyı göstermemek için | apisandbox=0 ekleyin.
Notlar
- Bu şablon bir vikimetin bağlantısı verir.
p1
...p9
URL parametrelerindeki boşluklar bağlantıyı bozar, bu yüzden onları%20
olarak değiştirin. - Benzer şekilde, URL parametrelerindeki "title1|title2" sayfa grubu gibi dikey çizgiyle ayrılmış tüm değerler çıkışlı olmalıdır, bu nedenle
{{!}}
sihirli kelimesini kullanın.
Örnek
Capitalization, localization, "_" => " ", "Project" => "Wikipedia", ...
Sonuç | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
<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>
|