Trợ giúp về API MediaWiki

This is an auto-generated MediaWiki API documentation page.

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

Mô đun chính

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.

Các tham số:
action

Tác vụ để thực hiện.

antispoof
Check a username against AntiSpoof's normalisation checks.
block
Cấm người dùng.
categorytree
Internal module for the CategoryTree extension.
changeauthenticationdata
Change authentication data for the current user.
checktoken
Check the validity of a token from action=query&meta=tokens.
clearhasmsg
Xóa cờ hasmsg cho người dùng hiện tại.
clientlogin
Log in to the wiki using the interactive flow.
compare
Get the difference between two pages.
createaccount
Mở tài khoản mới.
cspreport
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.
delete
Xóa trang.
edit
Tạo và sửa trang.
emailuser
Gửi thư cho người dùng.
embedvideo
⧼apihelp-embedvideo-summary⧽
expandtemplates
Bung tất cả bản mẫu trong văn bản wiki.
feedcontributions
Trả về nguồn cấp đóng góp người dùng.
feedrecentchanges
Trả về nguồn cấp thay đổi gần đây.
feedwatchlist
Trả về nguồn cấp danh sách theo dõi.
filerevert
Phục hồi một tập tin sang một phiên bản cũ.
getheaderfooter
Retrieve the parsed output of a header or footer in the context of a certain page.
help
Hiển thị trợ giúp cho các mô-đun xác định.
imagerotate
Xoay một hoặc nhiều hình ảnh.
import
Import a page from another wiki, or from an XML file.
linkaccount
Link an account from a third-party provider to the current user.
login
Log in and get authentication cookies.
logout
Thoát ra và xóa dữ liệu phiên làm việc.
managetags
Perform management tasks relating to change tags.
mergehistory
Hợp nhất lịch sử trang.
mobileview
Trả về dữ liệu cần thiết để hiển thị di động.
move
Di chuyển trang.
opensearch
Tìm kiếm trong wiki qua giao thức OpenSearch.
options
Change preferences of the current user.
paraminfo
Lấy thông tin về các module API.
parse
Parses content and returns parser output.
patrol
Patrol a page or revision.
protect
Change the protection level of a page.
purge
Purge the cache for the given titles.
query
Fetch data from and about MediaWiki.
removeauthenticationdata
Remove authentication data for the current user.
resetpassword
Send a password reset email to a user.
revisiondelete
Delete and undelete revisions.
rollback
Lùi lại sửa đổi cuối cùng của trang này.
rsd
Export an RSD (Really Simple Discovery) schema.
scribunto-console
Internal module for servicing XHR requests from the Scribunto console.
setnotificationtimestamp
Update the notification timestamp for watched pages.
setpagelanguage
Change the language of a page.
stashedit
Prepare an edit in shared cache.
tag
Add or remove change tags from individual revisions or log entries.
templatedata
Fetch data stored by the TemplateData extension.
transcodereset
Users with the 'transcode-reset' right can reset and re-run a transcode job.
unblock
Unblock a user.
undelete
Restore 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
Change a user's group membership.
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.
tokens
Bị phản đối. Get tokens for data-modifying actions.
Một trong các giá trị: antispoof, block, categorytree, changeauthenticationdata, checktoken, clearhasmsg, clientlogin, compare, createaccount, cspreport, delete, edit, emailuser, embedvideo, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, getheaderfooter, help, imagerotate, import, linkaccount, login, logout, managetags, mergehistory, mobileview, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, scribunto-console, setnotificationtimestamp, setpagelanguage, stashedit, tag, templatedata, transcodereset, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, tokens
Mặc định: help
format

Định dạng của dữ liệu được cho ra.

json
Cho ra dữ liệu dưới dạng JSON.
jsonfm
Cho ra dữ liệu dưới dạng JSON (định dạng bằng HTML).
none
Không cho ra gì.
php
Output data in serialized PHP format.
phpfm
Output data in serialized PHP format (pretty-print in HTML).
rawfm
Cho ra dữ liệu bao gồm các phần tử gỡ lỗi dưới dạng JSON (định dạng bằng HTML).
xml
Cho ra dữ liệu dưới dạng XML.
xmlfm
Cho ra dữ liệu dưới dạng XML (định dạng bằng HTML).
Một trong các giá trị: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
Mặc định: 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

Set the s-maxage HTTP cache control header to this many seconds. Errors are never cached.

Type: integer
Mặc định: 0
maxage

Set the max-age HTTP cache control header to this many seconds. Errors are never cached.

Type: integer
Mặc định: 0
assert

Verify the user is logged in if set to user, or has the bot user right if bot.

Một trong các giá trị: user, bot
assertuser

Verify the current user is the named user.

Type: user name
requestid

Any value given here will be included in the response. May be used to distinguish requests.

servedby

Include the hostname that served the request in the results.

Type: boolean (details)
curtimestamp

Include the current timestamp in the result.

Type: boolean (details)
responselanginfo

Include the languages used for uselang and errorlang in the result.

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 whitelisted, 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

Ngôn ngữ để sử dụng cho các bản dịch thông điệp. action=query&meta=siteinfo với siprop=languages trả về một danh sách các mã ngôn ngữ, hoặc định rõ user để sử dụng ngôn ngữ của người dùng hiện tại, hoặc định rõ content để sử dụng ngôn ngữ nội dung của wiki này.

Mặc định: user
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.
Một trong các giá trị: plaintext, wikitext, html, raw, none, bc
Mặc định: bc
errorlang

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

Mặc định: uselang
errorsuselocal

If given, error texts will use locally-customized messages from the MediaWiki namespace.

Type: boolean (details)
Các ví dụ:
Trợ giúp cho các mô-đun chính.
api.php?action=help [open in sandbox]
Tất cả trợ giúp trong một trang
api.php?action=help&recursivesubmodules=1 [open in sandbox]
Các quyền hạn:
writeapi
Sử dụng API để viết
Cấp cho: all và bot
apihighlimits
Use higher limits in API queries (slow queries: 500; fast queries: 5000). The limits for slow queries also apply to multivalue parameters.
Cấp cho: bot

Data types

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.

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.
timestamp
Timestamps may be specified in several formats. ISO 8601 date and time is recommended. All times are in UTC, any included timezone is ignored.
  • ISO 8601 date and time, 2001-01-15T14:56:00Z (punctuation and Z are optional)
  • ISO 8601 date and time with (ignored) fractional seconds, 2001-01-15T14:56:00.00001Z (dashes, colons, and Z are optional)
  • MediaWiki format, 20010115145600
  • Generic numeric format, 2001-01-15 14:56:00 (optional timezone of GMT, +##, or -## is ignored)
  • EXIF format, 2001:01:15 14:56:00
  • RFC 2822 format (timezone may be omitted), Mon, 15 Jan 2001 14:56:00
  • RFC 850 format (timezone may be omitted), Monday, 15-Jan-2001 14:56:00
  • C ctime format, Mon Jan 15 14:56:00 2001
  • Seconds since 1970-01-01T00:00:00Z as a 1 to 13 digit integer (excluding 0)
  • The string now
alternative multiple-value separator
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.

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.

Ghi công

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–present)

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