راهنمای واسط برنامه‌نویسی کاربردی مدیاویکی

این یک صفحهٔ مستندات برای واسط برنامه‌نویسی کاربردی مدیاویکی است که به‌طور خودکار ایجاد شده است.

مستندات و نمونه‌ها: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

action=query

(main | query)

این پودمان نیازمند اختیارات خواندن است.
منبع: MediaWiki
مجوز: GPL-2.0-or-later

Fetch data from and about MediaWiki.

All data modifications will first have to use query to acquire a token to prevent abuse from malicious sites.

پارامترها:

Other general parameters are available.

prop

Which properties to get for the queried pages.

categories: List all categories the pages belong to.
categoryinfo: Returns information about the given categories.
cirrusbuilddoc: Dump of a CirrusSearch article document from the database servers
cirruscompsuggestbuilddoc: Dump of the document used by the completion suggester
cirrusdoc: روگرفت از سند مقالهٔ CirrusSearch از سرورهای جستجو
contributors: Get the list of logged-in contributors and the count of logged-out contributors to a page.
deletedrevisions: Get deleted revision information.
duplicatefiles: List all files that are duplicates of the given files based on hash values.
extlinks: Returns all external URLs (not interwikis) from the given pages.
extracts: Returns plain-text or limited HTML extracts of the given pages.
fileusage: Find all pages that use the given files.
flagged: Get information about the flagging status of the given pages.
globalusage: فهرستی سراسری از کاربردهای یک تصویر خاص بر می‌گرداند.
imageinfo: Returns file information and upload history.
images: Returns all files contained on the given pages.
info: دریافت اطلاعات سادهٔ صفحه.
iwlinks: Returns all interwiki links from the given pages.
langlinks: Returns all interlanguage links from the given pages.
links: Returns all links from the given pages.
linkshere: Find all pages that link to the given pages.
mmcontent: Get the description and targets of a spamlist
pageimages: اطلاعات تصاویر موجود در صفحات منجمله نسخه بندانگشتی و حضور تصاویر را بر می‌گرداند.
pageprops: Get various page properties defined in the page content.
pageterms: Get the ویکی‌داده terms (typically labels, descriptions and aliases) associated with a page via a sitelink.
pageviews: Shows per-page pageview data (the number of daily pageviews for each of the last pvipdays days).
redirects: Returns all redirects to the given pages.
revisions: Get revision information.
stashimageinfo: Returns file information for stashed files.
templates: Returns all pages transcluded on the given pages.
transcludedin: Find all pages that transclude the given pages.
transcodestatus: Get transcode status for a given file page.
videoinfo: Extends imageinfo to include video source (derivatives) information
wbentityusage: برگرداندن همه شناسه‌های هستار استفاده شده در صفحه‌های داده شده.
description: داخلی Get a short description a.k.a. subtitle explaining what the target page is about.
mapdata: داخلی Request all Kartographer map data for the given pages

مقدارهای (جداشده با | یا جایگزین‌های آن): categories، categoryinfo، cirrusbuilddoc، cirruscompsuggestbuilddoc، cirrusdoc، contributors، deletedrevisions، duplicatefiles، extlinks، extracts، fileusage، flagged، globalusage، imageinfo، images، info، iwlinks، langlinks، links، linkshere، mmcontent، pageimages، pageprops، pageterms، pageviews، redirects، revisions، stashimageinfo، templates، transcludedin، transcodestatus، videoinfo، wbentityusage، description، mapdata

list

کدام فهرست‌ها دریافت شود.

abusefilters: نمایش جزئیات پالایهٔ ویرایش.
abuselog: نمایش رویدادهایی که توسط پالایه جلوگیری شده‌اند.
allcategories: Enumerate all categories.
alldeletedrevisions: List all deleted revisions by a user or in a namespace.
allfileusages: List all file usages, including non-existing.
allimages: متوالی شمردن همهٔ تصاویر.
alllinks: Enumerate all links that point to a given namespace.
allpages: Enumerate all pages sequentially in a given namespace.
allredirects: List all redirects to a namespace.
allrevisions: فهرست همه نسخه‌ها
alltransclusions: List all transclusions (pages embedded using {{x}}), including non-existing.
allusers: Enumerate all registered users.
backlinks: Find all pages that link to the given page.
betafeatures: فهرست همه ویژگی‌های آزمایشی
blocks: List all blocked users and IP addresses.
categorymembers: فهرست‌کردن همهٔ صفحه‌ها در یک ردهٔ مشخص‌شده.
centralnoticeactivecampaigns: Get a list of currently active campaigns with start and end dates and associated banners.
centralnoticelogs: Get a log of campaign configuration changes.
checkuser: بررسی کنید کدام نشانی‌های آی‌پی توسط یک حساب استفاده شده‌اند، یا کدام حساب‌ها توسط یک نشانی آی‌پی به کار رفته‌اند.
checkuserlog: دریافت موارد از سیاههٔ بازرسی.
configuredpages: Enumerate all pages that have custom review configurations.
embeddedin: Find all pages that embed (transclude) the given title.
exturlusage: Enumerate pages that contain a given URL.
filearchive: Enumerate all deleted files sequentially.
gadgetcategories: بازگرداندن فهرست رده‌های ابزارها
gadgets: بازگرداندن فهرست ابزارهای استفاده شده در این ویکی
globalallusers: شمارش تمام حساب‌های سراسری.
globalblocks: فهرست نشانی‌های اینترنتی که دسترسی‌شان به طور سراسری قطع شده است
globalgroups: شمارش تمام گروه‌های کاربری.
imageusage: Find all pages that use the given image title.
iwbacklinks: Find all pages that link to the given interwiki link.
langbacklinks: Find all pages that link to the given language link.
linterrors: دریافت فهرست خطاهای نحوی پنهان
logevents: دریافت رویدادها از سیاهه‌ها.
mostviewed: Lists the most viewed pages (based on last day's pageview count).
mystashedfiles: Get a list of files in the current user's upload stash.
oldreviewedpages: Enumerates pages that have changes pending review.
pagepropnames: List all page property names in use on the wiki.
pageswithprop: List all pages using a given page property.
prefixsearch: Perform a prefix search for page titles.
protectedtitles: List all titles protected from creation.
querypage: Get a list provided by a QueryPage-based special page.
random: Get a set of random pages.
recentchanges: Enumerate recent changes.
search: Perform a full text search.
tags: فهرست تغییرات برچسب‌ها.
unreviewedpages: Enumerates pages that have not been reviewed to a given quality level.
usercontribs: Get all edits by a user.
users: Get information about a list of users.
watchlist: Get recent changes to pages in the current user's watchlist.
watchlistraw: Get all pages on the current user's watchlist.
wblistentityusage: برگرداندن همهٔ صفحه‌هایی که شناسه‌های هستار داده‌شده را استفاده می‌کنند.
wikisets: شمارش تمام مجموعه‌های ویکی.
deletedrevs: منسوخ‌شده. List deleted revisions.
readinglistentries: داخلی List the pages of a certain list.

مقدارهای (جداشده با | یا جایگزین‌های آن): abusefilters، abuselog، allcategories، alldeletedrevisions، allfileusages، allimages، alllinks، allpages، allredirects، allrevisions، alltransclusions، allusers، backlinks، betafeatures، blocks، categorymembers، centralnoticeactivecampaigns، centralnoticelogs، checkuser، checkuserlog، configuredpages، embeddedin، exturlusage، filearchive، gadgetcategories، gadgets، globalallusers، globalblocks، globalgroups، imageusage، iwbacklinks، langbacklinks، linterrors، logevents، mostviewed، mystashedfiles، oldreviewedpages، pagepropnames، pageswithprop، prefixsearch، protectedtitles، querypage، random، recentchanges، search، tags، unreviewedpages، usercontribs، users، watchlist، watchlistraw، wblistentityusage، wikisets، deletedrevs، readinglistentries

حداکثر تعداد مقدارها ۵۰ است (۵۰۰ برای متقضایانی که مجوز محدودیت‌های بالاتر را دارند).

meta

کدام فراداده‌ها دریافت شود.

allmessages: Return messages from this site.
authmanagerinfo: بازیابی اطلاعات در مورد وضعيت کنونی تأیید اعتبار
babel: درباره زبان‌هایی که کاربر می‌داند اطلاعاتی بگیر
featureusage: Get a summary of logged API feature usages for a user agent.
filerepoinfo: Return meta information about image repositories configured on the wiki.
globalpreferences: بازیابی ترجیحات سراسری برای کاربر فعلی.
globalrenamestatus: نمایش اطلاعات تغییرنام‌های سراسری در حال انجام.
globaluserinfo: نمایش اطلاعات در مورد یک حساب سراسری.
languageinfo: Return information about available languages.
linterstats: دریافت تعداد خطای موجود در هر رده
notifications: دریافت آگاه‌سازی‌‌های منتظر کاربر کنونی.
siteinfo: Return general information about the site.
siteviews: Shows sitewide pageview data (daily pageview totals for each of the last pvisdays days).
tokens: Gets tokens for data-modifying actions.
unreadnotificationpages: دریافت صفحه‌هایی که برایش آگاه‌سازی‌های خوانده‌نشده‌ای برای کاربر فعلی وجود دارد.
userinfo: Get information about the current user.
wikibase: Get information about the Wikibase client and the associated Wikibase repository.
oath: داخلی Check to see if two-factor authentication (OATH) is enabled for a user.
readinglists: داخلی List or filter the user's reading lists and show metadata about them.

مقدارهای (جداشده با | یا جایگزین‌های آن): allmessages، authmanagerinfo، babel، featureusage، filerepoinfo، globalpreferences، globalrenamestatus، globaluserinfo، languageinfo، linterstats، notifications، siteinfo، siteviews، tokens، unreadnotificationpages، userinfo، wikibase، oath، readinglists

indexpageids

Include an additional pageids section listing all returned page IDs.

نوع: بولی (جزئیات)

export

Export the current revisions of all given or generated pages.

نوع: بولی (جزئیات)

exportnowrap

Return the export XML without wrapping it in an XML result (same format as Special:Export). Can only be used with query+export.

نوع: بولی (جزئیات)

exportschema

Target the given version of the XML dump format when exporting. Can only be used with query+export.

یکی از مقدارهای زیر: 0.10، 0.11

پیش‌فرض: 0.10

iwurl

Whether to get the full URL if the title is an interwiki link.

نوع: بولی (جزئیات)

continue

When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.

rawcontinue

Return raw query-continue data for continuation.

نوع: بولی (جزئیات)

titles

A list of titles to work on.

Separate values with | or alternative.

حداکثر تعداد مقدارها ۵۰ است (۵۰۰ برای متقضایانی که مجوز محدودیت‌های بالاتر را دارند).

pageids

A list of page IDs to work on.

نوع: فهرستی از اعداد صحیح

Separate values with | or alternative.

حداکثر تعداد مقدارها ۵۰ است (۵۰۰ برای متقضایانی که مجوز محدودیت‌های بالاتر را دارند).

revids

A list of revision IDs to work on. Note that almost all query modules will convert revision IDs to the corresponding page ID and work on the latest revision instead. Only prop=revisions uses exact revisions for its response.

نوع: فهرستی از اعداد صحیح

Separate values with | or alternative.

حداکثر تعداد مقدارها ۵۰ است (۵۰۰ برای متقضایانی که مجوز محدودیت‌های بالاتر را دارند).

generator

Get the list of pages to work on by executing the specified query module.

Note: Generator parameter names must be prefixed with a "g", see examples.

allcategories: Enumerate all categories.
alldeletedrevisions: List all deleted revisions by a user or in a namespace.
allfileusages: List all file usages, including non-existing.
allimages: متوالی شمردن همهٔ تصاویر.
alllinks: Enumerate all links that point to a given namespace.
allpages: Enumerate all pages sequentially in a given namespace.
allredirects: List all redirects to a namespace.
allrevisions: فهرست همه نسخه‌ها
alltransclusions: List all transclusions (pages embedded using {{x}}), including non-existing.
backlinks: Find all pages that link to the given page.
categories: List all categories the pages belong to.
categorymembers: فهرست‌کردن همهٔ صفحه‌ها در یک ردهٔ مشخص‌شده.
configuredpages: Enumerate all pages that have custom review configurations.
deletedrevisions: Get deleted revision information.
duplicatefiles: List all files that are duplicates of the given files based on hash values.
embeddedin: Find all pages that embed (transclude) the given title.
exturlusage: Enumerate pages that contain a given URL.
fileusage: Find all pages that use the given files.
images: Returns all files contained on the given pages.
imageusage: Find all pages that use the given image title.
iwbacklinks: Find all pages that link to the given interwiki link.
langbacklinks: Find all pages that link to the given language link.
links: Returns all links from the given pages.
linkshere: Find all pages that link to the given pages.
mostviewed: Lists the most viewed pages (based on last day's pageview count).
oldreviewedpages: Enumerates pages that have changes pending review.
pageswithprop: List all pages using a given page property.
prefixsearch: Perform a prefix search for page titles.
protectedtitles: List all titles protected from creation.
querypage: Get a list provided by a QueryPage-based special page.
random: Get a set of random pages.
recentchanges: Enumerate recent changes.
redirects: Returns all redirects to the given pages.
revisions: Get revision information.
search: Perform a full text search.
templates: Returns all pages transcluded on the given pages.
transcludedin: Find all pages that transclude the given pages.
unreviewedpages: Enumerates pages that have not been reviewed to a given quality level.
watchlist: Get recent changes to pages in the current user's watchlist.
watchlistraw: Get all pages on the current user's watchlist.
wblistentityusage: برگرداندن همهٔ صفحه‌هایی که شناسه‌های هستار داده‌شده را استفاده می‌کنند.
readinglistentries: داخلی List the pages of a certain list.

یکی از مقدارهای زیر: allcategories، alldeletedrevisions، allfileusages، allimages، alllinks، allpages، allredirects، allrevisions، alltransclusions، backlinks، categories، categorymembers، configuredpages، deletedrevisions، duplicatefiles، embeddedin، exturlusage، fileusage، images، imageusage، iwbacklinks، langbacklinks، links، linkshere، mostviewed، oldreviewedpages، pageswithprop، prefixsearch، protectedtitles، querypage، random، recentchanges، redirects، revisions، search، templates، transcludedin، unreviewedpages، watchlist، watchlistraw، wblistentityusage، readinglistentries

redirects

Automatically resolve redirects in query+titles, query+pageids, and query+revids, and in pages returned by query+generator.

نوع: بولی (جزئیات)

converttitles

Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include ban، en، crh، gan، iu، ku، sh، shi، sr، tg، tly، uz، wuu، zgh و zh.

نوع: بولی (جزئیات)

نمونه‌ها:

Fetch site info and revisions of صفحهٔ اصلی.: api.php?action=query&prop=revisions&meta=siteinfo&titles=%D8%B5%D9%81%D8%AD%D9%87%D9%94%20%D8%A7%D8%B5%D9%84%DB%8C&rvprop=user|comment&continue= [باز کردن در صفحهٔ تمرین]
Fetch revisions of pages beginning with API/.: api.php?action=query&generator=allpages&gapprefix=API/&prop=revisions&continue= [باز کردن در صفحهٔ تمرین]