MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

มอดูลหลัก

  • แหล่งที่มา: MediaWiki
  • สัญญาอนุญาต: GPL-2.0-or-later

Status: The MediaWiki API is a mature and stable interface that is actively supported and improved. While we try to avoid it, we may occasionally need to make breaking changes; subscribe to the mediawiki-api-announce mailing list for notice of updates.

Erroneous requests: When erroneous requests are sent to the API, an HTTP header will be sent with the key "MediaWiki-API-Error" and then both the value of the header and the error code sent back will be set to the same value. For more information see API: Errors and warnings.

Specific parameters:
action

การกระทำที่ต้องการให้ดำเนินการ

abusefiltercheckmatch
ตรวจสอบดูว่าตัวกรองการละเมิดกฎตรงกับชุดตัวแปร การแก้ไข หรือเหตุการณ์ตัวกรองการละเมิดกฎที่ลงบันทึกไว้หรือไม่
abusefilterchecksyntax
ตรวจสอบไวยากรณ์ของตัวกรอง AbuseFilter
abusefilterevalexpression
ประเมินนิพจน์ตัวกรองการละเมิดกฎ
abusefilterunblockautopromote
ปลดบล็อกผู้ใช้จากการได้รับการโปรโมตอัตโนมัติเนื่องจากผลของตัวกรองการละเมิดกฎ
abuselogprivatedetails
View private details of an AbuseLog entry.
acquiretempusername
Acquire a temporary user username and stash it in the current session, if temp account creation is enabled and the current user is logged out. If a name has already been stashed, returns the same name.
antispoof
ตรวจสอบการทำชื่อผู้ใช้ให้เป็นปกติกับ AntiSpoof
block
บล็อกผู้ใช้
centralauthtoken
Fetch a centralauthtoken for making an authenticated request to an attached wiki.
centralnoticecdncacheupdatebanner
Request the purge of banner content stored in the CDN (front-end) cache for anonymous users, for the requested banner and language
centralnoticechoicedata
Get data needed to choose a banner for a given project and language
centralnoticequerycampaign
Get all configuration settings for a campaign.
changeauthenticationdata
เปลี่ยนข้อมูลการยืนยันตัวตนสำหรับผู้ใช้ปัจจุบัน
changecontentmodel
เปลี่ยนตัวแบบเนื้อหาของหน้า
checktoken
ตรวจสอบความถูกต้องของโทเค็นจาก action=query&meta=tokens
cirrus-config-dump
Dump of CirrusSearch configuration.
cirrus-mapping-dump
Dump of CirrusSearch mapping for this wiki.
cirrus-profiles-dump
Dump of CirrusSearch profiles for this wiki.
cirrus-settings-dump
Dump of CirrusSearch settings for this wiki.
clearhasmsg
ล้างธง hasmsg สำหรับผู้ใช้ปัจจุบัน
clientlogin
เข้าสู่ระบบของวิกิโดยใช้โฟลว์เชิงโต้ตอบ
compare
รับข้อมูลความแตกต่างระหว่างสองหน้า
createaccount
สร้างบัญชีผู้ใช้ใหม่
createlocalaccount
Forcibly create a local account. The central account must exist.
delete
ลบหน้า
deleteglobalaccount
Delete a global user.
discussiontoolsedit
Post a message on a discussion page.
discussiontoolsfindcomment
Find a comment by its ID or name.
discussiontoolsgetsubscriptions
Get the subscription statuses of given topics.
discussiontoolssubscribe
Subscribe (or unsubscribe) to receive notifications about a topic.
echomarkread
Mark notifications as read for the current user.
echomarkseen
Mark notifications as seen for the current user.
echomute
Mute or unmute notifications from certain users or pages.
edit
สร้างและแก้ไขหน้า
editmassmessagelist
Edit a mass message delivery list.
emailuser
อีเมลผู้ใช้
expandtemplates
ขยายแม่แบบทั้งหมดภายในข้อความวิกิ
featuredfeed
Returns a featured content feed.
feedcontributions
Returns a user's contributions feed.
feedrecentchanges
Returns a recent changes feed.
feedwatchlist
Returns a watchlist feed.
filerevert
ย้อนไฟล์กลับเป็นรุ่นเก่า
globalblock
Globally block or unblock a user.
globalpreferenceoverrides
Change local overrides for global preferences for the current user.
globalpreferences
เปลี่ยนการตั้งค่ากลางของผู้ใช้ปัจจุบัน
globaluserrights
Add/remove a user to/from global groups.
help
แสดงวิธีใช้สำหรับมอดูลที่ระบุ
imagerotate
โมดูลนี้ได้ถูกปิดใช้งานแล้ว
import
Import a page from another wiki, or from an XML file.
jsonconfig
Allows direct access to JsonConfig subsystem.
languagesearch
Search for language names in any script.
linkaccount
Link an account from a third-party provider to the current user.
login
เข้าสู่ระบบและรับคุกกี้ยืนยันตัวตน
logout
ออกจากระบบและล้างข้อมูลช่วงเวลาสื่อสาร
managetags
Perform management tasks relating to change tags.
massmessage
Send a message to a list of pages.
mergehistory
ผสานประวัติหน้า
move
ย้ายหน้า
opensearch
Search the wiki using the OpenSearch protocol.
options
Change preferences of the current user.
paraminfo
ขอข้อมูลเกี่ยวกับมอดูล API
parse
Parses content and returns parser output.
patrol
ตรวจตราหน้าหรือรุ่นแก้ไข
protect
เปลี่ยนระดับการป้องกันของหน้า
purge
ล้างแคชสำหรับชื่อหน้าที่ระบุ
query
Fetch data from and about MediaWiki.
removeauthenticationdata
Remove authentication data for the current user.
resetpassword
ส่งอีเมลตั้งรหัสผ่านใหม่ให้ผู้ใช้
revisiondelete
ลบและกู้คืนรุ่นแก้ไข
rollback
Undo the last edit to the page.
rsd
Export an RSD (Really Simple Discovery) schema.
setglobalaccountstatus
Hide or lock (or unhide or unlock) a global user account.
setnotificationtimestamp
Update the notification timestamp for watched pages.
setpagelanguage
เปลี่ยนภาษาของหน้า
shortenurl
ย่อยูอาร์แอลแบบยาวให้สั้นลง
sitematrix
Get Wikimedia sites list.
spamblacklist
Validate one or more URLs against the spam block list.
streamconfigs
Exposes event stream config. Returns only format=json with formatversion=2.
strikevote
Allows admins to strike or unstrike a vote.
tag
Add or remove change tags from individual revisions or log entries.
templatedata
Fetch data stored by the TemplateData extension.
thank
Send a thank-you notification to an editor.
titleblacklist
Validate a page title, filename, or username against the TitleBlacklist.
torblock
Check if an IP address is blocked as a Tor exit node.
transcodereset
Users with the 'transcode-reset' right can reset and re-run a transcode job.
unblock
ปลดบล็อกผู้ใช้
undelete
Undelete revisions of a deleted page.
unlinkaccount
Remove a linked third-party account from the current user.
upload
Upload a file, or get the status of pending uploads.
userrights
เปลี่ยนการเป็นสมาชิกกลุ่มของผู้ใช้
validatepassword
Validate a password against the wiki's password policies.
watch
Add or remove pages from the current user's watchlist.
webapp-manifest
Returns a webapp manifest.
webauthn
API Module to communicate between server and client during registration/authentication process.
bouncehandler
Internal. Receive a bounce email and process it to handle the failing recipient.
categorytree
Internal. Internal module for the CategoryTree extension.
cirrus-check-sanity
Internal. Reports on the correctness of a range of page ids in the search index
collection
Internal. API module for performing various operations on a wiki user's collection.
cspreport
Internal. Used by browsers to report violations of the Content Security Policy. This module should never be used, except when used automatically by a CSP compliant web browser.
discussiontoolscompare
Internal. Get information about comment changes between two page revisions.
discussiontoolspageinfo
Internal. Returns metadata required to initialize the discussion tools.
discussiontoolspreview
Internal. Preview a message on a discussion page.
editcheckreferenceurl
Internal. Check the status of a URL for use as a reference.
fancycaptchareload
Internal. Get a new FancyCaptcha.
jsondata
Internal. Retrieve localized JSON data.
oathvalidate
Internal. Validate a two-factor authentication (OATH) token.
parser-migration
Internal. Parse a page with two different parser configurations.
readinglists
Internal. Reading list write operations.
sanitize-mapdata
Internal. Performs data validation for Kartographer extension
scribunto-console
Internal. มอดูลภายในสำหรับให้บริการการร้องขอ XHR จากคอนโซล Scribunto
securepollauth
Internal. Allows a remote wiki to authenticate users before granting access to vote in the election.
stashedit
Internal. Prepare an edit in shared cache.
timedtext
Internal. Provides timed text content for usage by <track> elements
ulslocalization
Internal. Get the localization of ULS in the given language.
ulssetlang
Internal. Update user's preferred interface language.
visualeditor
Internal. Returns HTML5 for a page from the Parsoid service.
visualeditoredit
Internal. Save an HTML5 page to MediaWiki (converted to wikitext via the Parsoid service).
wikimediaeventsblockededit
Internal. Log information about blocked edit attempts
ค่าใดค่าหนึ่งต่อไปนี้: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, abuselogprivatedetails, acquiretempusername, antispoof, block, centralauthtoken, centralnoticecdncacheupdatebanner, centralnoticechoicedata, centralnoticequerycampaign, changeauthenticationdata, changecontentmodel, checktoken, cirrus-config-dump, cirrus-mapping-dump, cirrus-profiles-dump, cirrus-settings-dump, clearhasmsg, clientlogin, compare, createaccount, createlocalaccount, delete, deleteglobalaccount, discussiontoolsedit, discussiontoolsfindcomment, discussiontoolsgetsubscriptions, discussiontoolssubscribe, echomarkread, echomarkseen, echomute, edit, editmassmessagelist, emailuser, expandtemplates, featuredfeed, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, globalblock, globalpreferenceoverrides, globalpreferences, globaluserrights, help, imagerotate, import, jsonconfig, languagesearch, linkaccount, login, logout, managetags, massmessage, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setglobalaccountstatus, setnotificationtimestamp, setpagelanguage, shortenurl, sitematrix, spamblacklist, streamconfigs, strikevote, tag, templatedata, thank, titleblacklist, torblock, transcodereset, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, webauthn, bouncehandler, categorytree, cirrus-check-sanity, collection, cspreport, discussiontoolscompare, discussiontoolspageinfo, discussiontoolspreview, editcheckreferenceurl, fancycaptchareload, jsondata, oathvalidate, parser-migration, readinglists, sanitize-mapdata, scribunto-console, securepollauth, stashedit, timedtext, ulslocalization, ulssetlang, visualeditor, visualeditoredit, wikimediaeventsblockededit
Default: help
format

รูปแบบของผลลัพธ์

json
Output data in JSON format.
jsonfm
Output data in JSON format (pretty-print in HTML).
none
Output nothing.
php
Output data in serialized PHP format.
phpfm
Output data in serialized PHP format (pretty-print in HTML).
rawfm
Output data, including debugging elements, in JSON format (pretty-print in HTML).
xml
Output data in XML format.
xmlfm
Output data in XML format (pretty-print in HTML).
ค่าใดค่าหนึ่งต่อไปนี้: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
Default: jsonfm
maxlag

Maximum lag can be used when MediaWiki is installed on a database replicated cluster. To save actions causing any more site replication lag, this parameter can make the client wait until the replication lag is less than the specified value. In case of excessive lag, error code maxlag is returned with a message like Waiting for $host: $lag seconds lagged.
See Manual: Maxlag parameter for more information.

Type: integer
smaxage

ตั้งส่วนหัวควบคุมแคช HTTP s-maxage เป็นจำนวนวินาทีต่อไปนี้ ข้อผิดพลาดจะไม่ถูกแคช

Type: integer
The value must be no less than 0.
Default: 0
maxage

ตั้งส่วนหัวควบคุมแคช HTTP max-age เป็นจำนวนวินาทีต่อไปนี้ ข้อผิดพลาดจะไม่ถูกแคช

Type: integer
The value must be no less than 0.
Default: 0
assert

ยืนยันว่าผู้ใช้ล็อกอินแล้วถ้าตั้งเป็น user หรือให้มีสิทธิ์ผู้ใช้บอตถ้าตั้งเป็น bot

ค่าใดค่าหนึ่งต่อไปนี้: anon, bot, user
assertuser

ยืนยันว่าผู้ใช้ปัจจุบันเป็นผู้ใช้มีชื่อ

ชนิด: ผู้ใช้ โดย ชื่อผู้ใช้ และ ผู้ใช้ชั่วคราว
requestid

ค่าใด ๆ ก็ตามที่กำหนดไว้ที่นี่จะถูกรวมไว้ในการตอบกลับด้วย อาจใช้เพื่อแยกแยะคำขอได้

servedby

รวมชื่อโฮสต์ที่ทำหน้าที่ร้องขอไว้ในผลลัพธ์

Type: boolean (details)
curtimestamp

รวมประทับเวลาปัจจุบันไว้ในผลลัพธ์

Type: boolean (details)
responselanginfo

รวมภาษาที่ใช้สำหรับ uselang และ errorlang ไว้ในผลลัพธ์

Type: boolean (details)
origin

When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body).

For authenticated requests, this must match one of the origins in the Origin header exactly, so it has to be set to something like https://en.wikipedia.org or https://meta.wikimedia.org. If this parameter does not match the Origin header, a 403 response will be returned. If this parameter matches the Origin header and the origin is allowed, the Access-Control-Allow-Origin and Access-Control-Allow-Credentials headers will be set.

For non-authenticated requests, specify the value *. This will cause the Access-Control-Allow-Origin header to be set, but Access-Control-Allow-Credentials will be false and all user-specific data will be restricted.

uselang

ภาษาที่จะใช้สำหรับการแปลข้อความ action=query&meta=siteinfo พร้อม siprop=languages แสดงรายชื่อรหัสภาษา หรือระบุ user เพื่อใช้การตั้งค่าภาษาปัจจุบันของผู้ใช้ หรือระบุ content เพื่อใช้ภาษาเนื้อหาของวิกินี้

Default: user
variant

Variant of the language. Only works if the base language supports variant conversion.

errorformat

Format to use for warning and error text output

plaintext
Wikitext with HTML tags removed and entities replaced.
wikitext
Unparsed wikitext.
html
HTML
raw
Message key and parameters.
none
No text output, only the error codes.
bc
Format used prior to MediaWiki 1.29. errorlang and errorsuselocal are ignored.
ค่าใดค่าหนึ่งต่อไปนี้: bc, html, none, plaintext, raw, wikitext
Default: bc
errorlang

Language to use for warnings and errors. action=query&meta=siteinfo&siprop=languages returns a list of language codes. Specify content to use this wiki's content language or uselang to use the same value as the uselang parameter.

Default: uselang
errorsuselocal

ถ้าระบุไว้ ข้อความระบุข้อผิดพลาดจะใช้ข้อความที่ปรับแต่งเฉพาะที่จากเนมสเปซ มีเดียวิกิ

Type: boolean (details)
centralauthtoken

When accessing the API using a cross-domain AJAX request (CORS), use this to authenticate as the current SUL user. Use action=centralauthtoken on this wiki to retrieve the token, before making the CORS request. Each token may only be used once, and expires after 10 seconds. This should be included in any pre-flight request, and therefore should be included in the request URI (not the POST body).

ตัวอย่าง:
วิธีใช้สำหรับมอดูลหลัก
api.php?action=help [เปิดในกระบะทราย]
วิธีใช้ทั้งหมดในหน้าเดียว
api.php?action=help&recursivesubmodules=1 [เปิดในกระบะทราย]
สิทธิ:
writeapi
ใช้การเขียนเอพีไอ
มอบให้: all, user และ bot
apihighlimits
Use higher limits in API queries (slow queries: 500; fast queries: 5000). The limits for slow queries also apply to multivalue parameters.
มอบให้: bot และ sysop

ชนิดของข้อมูล

Input to MediaWiki should be NFC-normalized UTF-8. MediaWiki may attempt to convert other input, but this may cause some operations (such as edits with MD5 checks) to fail.

Parameters that take multiple values are normally submitted with the values separated using the pipe character, e.g. param=value1|value2 or param=value1%7Cvalue2. If a value must contain the pipe character, use U+001F (Unit Separator) as the separator and prefix the value with U+001F, e.g. param=%1Fvalue1%1Fvalue2.

Some parameter types in API requests need further explanation:

boolean

Boolean parameters work like HTML checkboxes: if the parameter is specified, regardless of value, it is considered true. For a false value, omit the parameter entirely.

expiry

Expiry values may be relative (e.g. 5 months or 2 weeks) or absolute (e.g. 2014-09-18T12:34:56Z). For no expiry, use infinite, indefinite, infinity or never.

timestamp

Timestamps may be specified in several formats, see the Timestamp library input formats documented on mediawiki.org for details. ISO 8601 date and time is recommended: 2001-01-15T14:56:00Z. Additionally, the string now may be used to specify the current timestamp.

Templated parameters

Templated parameters support cases where an API module needs a value for each value of some other parameter. For example, if there were an API module to request fruit, it might have a parameter fruits to specify which fruits are being requested and a templated parameter {fruit}-quantity to specify how many of each fruit to request. An API client that wants 1 apple, 5 bananas, and 20 strawberries could then make a request like fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20.

เครดิต

API developers:

  • Yuri Astrakhan (creator, lead developer Sep 2006–Sep 2007)
  • Roan Kattouw (lead developer Sep 2007–2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Brad Jorsch (lead developer 2013–2020)

Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org or file a bug report at https://phabricator.wikimedia.org/.