MediaWiki API 帮助

这是自动生成的MediaWiki API文档页面。

文档和例子：https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

主模块

状态：MediaWiki API是一个成熟稳定的接口，得到了积极的支持和改进。尽管我们尽力避免，但偶尔也需要作出重大更新；请订阅mediawiki-api-announce 邮件列表以便获得更新通知。

错误请求：当API收到错误请求时，HTTP header将会返回一个包含"MediaWiki-API-Error"的值，随后header的值与error code将会送回并设置为相同的值。详细信息请参阅API：错误与警告。

测试中：测试API请求的易用性，请参见Special:ApiSandbox。

参数：
action

要执行的操作。

block
封禁一位用户。
changeauthenticationdata
更改当前用户的身份验证数据。
changecontentmodel
变更页面的内容模型
checktoken
从action=query&meta=tokens检查令牌有效性。
clearhasmsg
清除当前用户的hasmsg标记。
clientlogin
使用交互式流登录wiki。
commentblock
评论封禁API允许封禁用户的评论权，它在填写以下参数后出现：评论ID。
commentdelete
评论封禁API允许删除评论，在填写完以下参数的情况下：评论ID。
commentlatestid
评论最新ID API允许检索最近评论的ID，在填写完以下参数的情况下：页面ID。
commentlist
评论列表API检索多条评论，并将其输出为列表，在填写完以下参数的情况下：页面ID、排序、纸张页面及显示表单。
commentsubmit
评论提交API允许提交/发布评论，在填写完以下参数的情况下：页面ID、父ID及评论文本。
commentvote
评论投票API允许对评论投票，在填写完以下参数的情况下：评论ID及投票值。
compare
获取两页面之间的差异。
createaccount
创建一个新用户账号。
delete
删除一个页面。
edit
创建和编辑页面。
emailuser
电子邮件联系一位用户。
expandtemplates
展开wikitext中的所有模板。
feedcontributions
返回用户贡献纲要。
feedrecentchanges
返回最近更改的摘要。
feedwatchlist
返回监视列表纲要。
filerevert
回退一个文件至某一旧版本。
help
显示指定模块的帮助。
imagerotate
旋转一幅或多幅图像。
import
从其他wiki，或从XML文件导入页面。
linkaccount
将来自第三方提供商的账号链接至当前用户。
login
登录并获取身份验证cookie。
logout
退出并清除会话数据。
managetags
执行有关更改标签的管理任务。
mergehistory
合并页面历史。
move
移动一个页面。
opensearch
使用开放搜索协议搜索wiki。
options
更改当前用户的参数设置。
paraminfo
获得关于API模块的信息。
parse
解析内容并返回解析器输出。
patrol
巡查页面或修订版本。
protect
更改页面的保护等级。
purge
为指定标题刷新缓存。
query
取得来自并有关MediaWiki的数据。
removeauthenticationdata
从当前用户移除身份验证数据。
resetpassword
向用户发送密码重置邮件。
revisiondelete
删除和恢复修订版本。
rollback
撤销对页面的最近编辑。
rsd
导出一个RSD（Really Simple Discovery）架构。
setnotificationtimestamp
更新监视页面的通知时间戳。
setpagelanguage
更改页面的语言。
tag
从个别修订或日志记录中添加或移除更改标签。
transcodereset
持有“transcode-reset”权限的用户可以重置并重启转码作业。
unblock
解封一位用户。
undelete
取消删除页面的修订版本。
unlinkaccount
从当前用户移除已链接的第三方账号。
upload
上传文件，或获取正在等待中的上传的状态。
userrights
更改一位用户的组成员。
validatepassword
验证密码是否符合wiki的密码方针。
watch
从当前用户的监视列表中添加或移除页面。
cspreport
内部的。由浏览器使用以报告违反内容安全方针的内容。此模块应永不使用，除了在被CSP兼容的浏览器自动使用时。
stashedit
内部的。在分享缓存中准备编辑。
timedtext
内部的。提供被音轨元素所使用的字幕
以下值中的一个：block、​changeauthenticationdata、​changecontentmodel、​checktoken、​clearhasmsg、​clientlogin、​commentblock、​commentdelete、​commentlatestid、​commentlist、​commentsubmit、​commentvote、​compare、​createaccount、​delete、​edit、​emailuser、​expandtemplates、​feedcontributions、​feedrecentchanges、​feedwatchlist、​filerevert、​help、​imagerotate、​import、​linkaccount、​login、​logout、​managetags、​mergehistory、​move、​opensearch、​options、​paraminfo、​parse、​patrol、​protect、​purge、​query、​removeauthenticationdata、​resetpassword、​revisiondelete、​rollback、​rsd、​setnotificationtimestamp、​setpagelanguage、​tag、​transcodereset、​unblock、​undelete、​unlinkaccount、​upload、​userrights、​validatepassword、​watch、​cspreport、​stashedit、​timedtext
默认：help
format

输出的格式。

json
输出数据为JSON格式。
jsonfm
输出数据为JSON格式（使用HTML格式显示）。
none
不输出任何东西。
php
输出数据为序列化PHP格式。
phpfm
输出数据为序列化PHP格式（使用HTML格式显示）。
rawfm
输出数据为JSON格式，包含调试元素（使用HTML格式显示）。
xml
输出数据为XML格式。
xmlfm
输出数据为XML格式（使用HTML格式显示）。
以下值中的一个：json、​jsonfm、​none、​php、​phpfm、​rawfm、​xml、​xmlfm
默认：jsonfm
maxlag

最大延迟可被用于MediaWiki安装于数据库复制集中。要保存导致更多网站复制延迟的操作，此参数可使客户端等待直到复制延迟少于指定值时。万一发生过多延迟，错误代码maxlag会返回消息，例如等待$host中：延迟$lag秒。
参见手册:Maxlag参数以获取更多信息。

类型：整数
smaxage

设置s-maxage HTTP缓存控制头至这些秒。错误不会缓存。

类型：整数
默认：0
maxage

设置max-age HTTP缓存控制头至这些秒。错误不会缓存。

类型：整数
默认：0
assert

如果设置为user就验证用户已登录；如果设置为anon就验证用户未登录；如果设置为bot就验证是否有机器人用户权限。

以下值中的一个：anon、​bot、​user
assertuser

验证当前用户是命名用户。

类型：通过 用户名 方式指定的用户
requestid

任何在此提供的值将包含在响应中。可以用以区别请求。

servedby

包含保存结果请求的主机名。

类型：布尔型 (详情)
curtimestamp

在结果中包括当前时间戳。

类型：布尔型 (详情)
responselanginfo

包含在结果中用于uselang和errorlang的语言。

类型：布尔型 (详情)
origin

使用跨域AJAX请求(CORS)访问API时，请将其设置为原始域。这必须包括在任何pre-flight请求中，因此必须是请求URI（而不是POST正文）的一部分。

对于已验证的请求，这必须正确匹配Origin标头中的原点之一，因此必须将其设置为类似https://zh.wikipedia.org或https://meta.wikimedia.org的东西。如果此参数不匹配Origin页顶，就返回403错误响应。如果此参数与Origin标头不匹配，将返回403响应。如果此参数与Origin标头匹配并且允许来源，则将设置Access-Control-Allow-Origin和Access-Control-Allow-Credentials开头。

对于未验证的请求，会指定值*。这将导致Access-Control-Allow-Origin标头被设置，但Access-Control-Allow-Credentials将为false，且所有用户特定数据将受限制。

uselang

用于消息翻译的语言。action=query&meta=siteinfo与siprop=languages可返回语言代码列表，或指定user以使用当前用户的语言设置，或指定content以使用此wiki的内容语言。

默认：user
variant

语言变种。仅当基础语言支持变种转换时起作用。

errorformat

用于警告和错误文本输出的格式

plaintext
包括HTML标签的wikitext被移除并且实体被替换。
wikitext
未解析的wikitext。
html
HTML
raw
消息的键和参数。
none
没有文本输出，仅有错误代码。
bc
MediaWiki 1.29之前使用的格式。errorlang和errorsuselocal会被忽略。
以下值中的一个：bc、​html、​none、​plaintext、​raw、​wikitext
默认：bc
errorlang

用于警告和错误的语言。action=query&meta=siteinfo带siprop=languages返回语言代码的列表，或指定content以使用此wiki的内容语言，或指定uselang以使用与uselang参数相同的值。

默认：uselang
errorsuselocal

如果指定，错误文本将使用来自MediaWiki命名空间的本地自定义消息。

类型：布尔型 (详情)
例子：
主模块帮助。
api.php?action=help [在沙盒中打开]
一个页面中的所有帮助。
api.php?action=help&recursivesubmodules=1 [在沙盒中打开]
权限：
writeapi
使用写入API
授予：all、​user和bot
apihighlimits
在API查询中使用更高的上限（慢查询：500；快查询：5000）。慢查询的限制也适用于多值参数。
授予：bot和sysop

数据类型

MediaWiki的输入应该是NFC规范化的UTF-8。MediaWiki可能会尝试转换其他输入，但这可能会导致某些操作（例如 编辑带有MD5检查）失败。

采用多个值的参数通常与使用管道字符分隔的值一起提交，例如param=value1|value2或param=value1%7Cvalue2。如果值必须包含竖线字符，请使用U+001F（单位分隔符）作为分隔符 并且 用U+001F作为该值的前缀，例如param=%1Fvalue1%1Fvalue2。

API请求中的一些参数类型需要进一步说明：

boolean

布尔参数的工作方式类似于HTML复选框：如果指定了参数，无论值如何，它都被认为是true。对于假值，完全省略参数。

expiry

到期值可能是相对的（例如5个月或2周）或绝对值（例如2014-09-18T12:34:56Z）。如果没有截止如期，请使用infinite、infinite、infinity或never。

timestamp

时间戳可以用多种格式指定，详情参见mediawiki.org上记录的时间戳库输入格式。建议使用ISO 8601日期和时间：2001-01-15T14: 56:00Z。此外，字符串now可用于指定当前时间戳。

模板参数

模板参数支持API模块需要为每个其他参数赋值的情况。例如如果有API模块请求水果，它会有参数水果指定请求的水果，以及模板参数{水果}-数量以指定每种水果请求多少。需要1个苹果、5个香蕉和20个草莓的API客户端可以做出类似水果=苹果|香蕉|草莓&苹果-数量=1&香蕉-数量=5&草莓-数量=20的请求。

制作人员

API 开发人员：

  • Yuri Astrakhan（创建者，2006å¹´9月~2007å¹´9月的开发组领导）
  • Roan Kattouw（2007å¹´9月~2009年的开发组领导）
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Brad Jorsch（2013å¹´~2020年的开发组领导）

请将您的评论、建议和问题发送至mediawiki-api@lists.wikimedia.org，或提交错误请求至https://phabricator.wikimedia.org/。

取自“http://mtf.aimo.moe/wiki/特殊:Api帮助”