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

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

مستندات و نمونه‌ها: 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.

پارامترها:

prop

Which properties to get for the queried pages.

categories: List all categories the pages belong to.
categoryinfo: Returns information about the given categories.
contributors: Get the list of logged-in contributors and the count of anonymous 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.
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.
pageimages: اطلاعات تصاویر موجود در صفحات منجمله نسخه بندانگشتی و حضور تصاویر را بر می‌گرداند.
pageprops: Get various page properties defined in the page content.
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.

مقدارهای (جداشده با | یا جایگزین‌های آن): categories، categoryinfo، contributors، deletedrevisions، duplicatefiles، extlinks، extracts، fileusage، imageinfo، images، info، iwlinks، langlinks، links، linkshere، pageimages، pageprops، redirects، revisions، stashimageinfo، templates، transcludedin

list

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

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.
blocks: List all blocked users and IP addresses.
categorymembers: فهرست‌کردن همهٔ صفحه‌ها در یک ردهٔ مشخص‌شده.
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: بازگرداندن فهرست ابزارهای استفاده شده در این ویکی
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.
logevents: دریافت رویدادها از سیاهه‌ها.
mystashedfiles: Get a list of files in the current user's upload stash.
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: فهرست تغییرات برچسب‌ها.
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.
deletedrevs: منسوخ‌شده. List deleted revisions.

مقدارهای (جداشده با | یا جایگزین‌های آن): allcategories، alldeletedrevisions، allfileusages، allimages، alllinks، allpages، allredirects، allrevisions، alltransclusions، allusers، backlinks، blocks، categorymembers، embeddedin، exturlusage، filearchive، gadgetcategories، gadgets، imageusage، iwbacklinks، langbacklinks، logevents، mystashedfiles، pagepropnames، pageswithprop، prefixsearch، protectedtitles، querypage، random، recentchanges، search، tags، usercontribs، users، watchlist، watchlistraw، deletedrevs

meta

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

allmessages: Return messages from this site.
authmanagerinfo: بازیابی اطلاعات در مورد وضعيت کنونی تأیید اعتبار
filerepoinfo: Return meta information about image repositories configured on the wiki.
languageinfo: Return information about available languages.
siteinfo: Return general information about the site.
tokens: Gets tokens for data-modifying actions.
userinfo: Get information about the current user.
oath: داخلی Check to see if two-factor authentication (OATH) is enabled for a user.

مقدارهای (جداشده با | یا جایگزین‌های آن): allmessages، authmanagerinfo، filerepoinfo، languageinfo، siteinfo، tokens، userinfo، oath

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.11

iwurl

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

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

continue

When more results are available, use this to continue.

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.

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

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: فهرست‌کردن همهٔ صفحه‌ها در یک ردهٔ مشخص‌شده.
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.
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.
watchlist: Get recent changes to pages in the current user's watchlist.
watchlistraw: Get all pages on the current user's watchlist.

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

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، kk، ku، shi، sr، tg، uz و zh.

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

نمونه‌ها:

Fetch site info and revisions of Main Page.: api.php?action=query&prop=revisions&meta=siteinfo&titles=Main%20Page&rvprop=user|comment&continue= [باز کردن در صفحهٔ تمرین]
Fetch revisions of pages beginning with API/.: api.php?action=query&generator=allpages&gapprefix=API/&prop=revisions&continue= [باز کردن در صفحهٔ تمرین]