MediaWiki API 帮助

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

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

主模块

main

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

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

参数:
action

要执行的操作。

abusefiltercheckmatch
检查以查看防滥用过滤器是否匹配某个变量集、某次编辑或某条日志记载的过滤器活动。
abusefilterchecksyntax
检查一个防滥用过滤器的语法。
abusefilterevalexpression
评估防滥用过滤器的表达式。
abusefilterunblockautopromote
从由于防滥用过滤器的结果而接受的autopromotions解封用户。
abuselogprivatedetails
显示一个AbuseLog入口的私有信息
ask
使用请求语言查询语义MediaWiki的API模块。
askargs
使用请求语言作为条件、打印输出和参数的列表,来查询语义MediaWiki的API模块。
block
封禁一位用户。
changeauthenticationdata
更改当前用户的身份验证数据。
changecontentmodel
变更页面的内容模型
checktoken
action=query&meta=tokens检查令牌有效性。
cirrus-config-dump
CirrusSearch配置的转储。
cirrus-mapping-dump
用于此wiki的CirrusSearch映射转储。
cirrus-profiles-dump
此Wiki上的CirrusSearch配置文件转储。
cirrus-settings-dump
用于此wiki的CirrusSearch设置转储。
clearhasmsg
清除当前用户的hasmsg标记。
clientlogin
使用交互式流登录wiki。
compare
获取两页面之间的差异。
createaccount
创建一个新用户账户。
delete
删除一个页面。
echomarkread
对当前用户标记通知为已读。
echomarkseen
对当前用户标记通知为已读。
echomute
将来自某些用户或页面的通知静音或取消静音。
edit
创建和编辑页面。
emailuser
电子邮件联系一位用户。
expandtemplates
展开wikitext中的所有模板。
ext.srf.slideshow.show
feedcontributions
返回用户贡献纲要。
feedrecentchanges
返回最近更改的摘要。
feedwatchlist
返回监视列表纲要。
filerevert
回退一个文件至某一旧版本。
flowthread
help
显示指定模块的帮助。
imagerotate
旋转一幅或多幅图像。
import
从其他wiki,或从XML文件导入页面。
linkaccount
将来自第三方提供商的账户链接至当前用户。
login
登录并获取身份验证cookie。
logout
退出并清除会话数据。
managetags
执行有关更改标签的管理任务。
mergehistory
合并页面历史。
moderation
Performs moderation-related action like Approve or Reject.
move
移动一个页面。
newpagenumber
opensearch
使用开放搜索协议搜索wiki。
options
更改当前用户的参数设置。
paraminfo
获得关于API模块的信息。
parse
解析内容并返回解析器输出。
patrol
巡查页面或修订版本。
pfautocomplete
由页面表单扩展所使用的自动完成。
pfautoedit
使用页面表单扩展定义的表单创建或编辑页面。
pollsubmitvote
AJAXPoll API模块
protect
更改页面的保护等级。
purge
为指定标题刷新缓存。
query
取得来自并有关MediaWiki的数据。
removeauthenticationdata
从当前用户移除身份验证数据。
resetpassword
向用户发送密码重置邮件。
revisiondelete
删除和恢复修订版本。
rollback
撤销对页面的最近编辑。
rsd
导出一个RSD(Really Simple Discovery)架构。
setnotificationtimestamp
更新监视页面的通知时间戳。
setpagelanguage
更改页面的语言。
smwbrowse
对不同的实体类型支持浏览与搜索活动的Semantic MediaWiki API模块。
smwinfo
检索有关语义MediaWiki统计信息及其他元信息的API模块。
smwtask
执行语义MediaWiki相关任务的API模块(仅内部使用,不公开)。
spamblacklist
验证一个或多个URL是否触发垃圾链接黑名单。
tag
从个别修订或日志记录中添加或移除更改标签。
templatedata
获取由模板数据扩展存储的数据。
titleblacklist
验证一个页面的标题、文件名或用户名是否触发标题黑名单。
unblock
解封一位用户。
undelete
恢复删除页面的修订版本。
unlinkaccount
从当前用户移除已连接的第三方账户。
upload
上传文件,或获取正在等待中的上传的状态。
userrights
更改一位用户的组成员。
validatepassword
验证密码是否符合wiki的密码方针。
watch
从当前用户的监视列表中添加或移除页面。
webapp-manifest
返回webapp证明。
browsebyproperty
已弃用。检索有关某一属性,或是属性列表信息的API模块。
browsebysubject
已弃用。检索有关主题信息的API模块。
mobileview
已弃用。返回移动浏览需要的数据。
categorytree
内部的。用于CategoryTree扩展的内部模块。
cspreport
内部的。由浏览器使用以报告违反内容安全方针的内容。此模块应永不使用,除了在被CSP兼容的浏览器自动使用时。
scribunto-console
内部的。从Scribunto控制台提供XHR请求的内部模块。
stashedit
内部的。在分享缓存中准备编辑。
以下值中的一个:abusefiltercheckmatchabusefilterchecksyntaxabusefilterevalexpressionabusefilterunblockautopromoteabuselogprivatedetailsaskaskargsblockchangeauthenticationdatachangecontentmodelchecktokencirrus-config-dumpcirrus-mapping-dumpcirrus-profiles-dumpcirrus-settings-dumpclearhasmsgclientlogincomparecreateaccountdeleteechomarkreadechomarkseenechomuteeditemailuserexpandtemplatesext.srf.slideshow.showfeedcontributionsfeedrecentchangesfeedwatchlistfilerevertflowthreadhelpimagerotateimportlinkaccountloginlogoutmanagetagsmergehistorymoderationmovenewpagenumberopensearchoptionsparaminfoparsepatrolpfautocompletepfautoeditpollsubmitvoteprotectpurgequeryremoveauthenticationdataresetpasswordrevisiondeleterollbackrsdsetnotificationtimestampsetpagelanguagesmwbrowsesmwinfosmwtaskspamblacklisttagtemplatedatatitleblacklistunblockundeleteunlinkaccountuploaduserrightsvalidatepasswordwatchwebapp-manifestbrowsebypropertybrowsebysubjectmobileviewcategorytreecspreportscribunto-consolestashedit
默认:help
format

输出的格式。

json
输出数据为JSON格式。
jsonfm
输出数据为JSON格式(使用HTML格式显示)。
none
不输出任何东西。
php
输出数据为序列化PHP格式。
phpfm
输出数据为序列化PHP格式(使用HTML格式显示)。
rawfm
输出数据为JSON格式,包含调试元素(使用HTML格式显示)。
xml
输出数据为XML格式。
xmlfm
输出数据为XML格式(使用HTML格式显示)。
以下值中的一个:jsonjsonfmnonephpphpfmrawfmxmlxmlfm
默认: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

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

类型:布尔型 (详情)
userId
⧼apihelp-main-param-userId⧽
类型:布尔型 (详情)
curtimestamp

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

类型:布尔型 (详情)
responselanginfo

包含在结果中用于uselangerrorlang的语言。

类型:布尔型 (详情)
origin

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

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

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

uselang

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

默认:user
errorformat

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

plaintext
包括HTML标签的wikitext被移除并且实体被替换。
wikitext
未解析的wikitext。
html
HTML
raw
消息的键和参数。
none
没有文本输出,仅有错误代码。
bc
Format used prior to MediaWiki 1.29. errorlang and errorsuselocal are ignored.
以下值中的一个:bc、html、none、plaintext、raw、wikitext
默认:bc
errorlang

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

默认:uselang
errorsuselocal

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

类型:布尔型 (详情)
权限:
writeapi
使用写入API
授予:all、user和bot
apihighlimits
在API查询中使用更高的上限(慢查询:500;快查询:5000)。慢查询的限制也适用于多值参数。
授予:bot和sysop

action=abusefiltercheckmatch

  • 此模块需要读取权限。
  • 来源:Abuse Filter
  • 许可协议:GPL-2.0-or-later

检查以查看防滥用过滤器是否匹配某个变量集、某次编辑或某条日志记载的过滤器活动。

需要vars、rcid或logid,然而只有其中一个会用到。

参数:
filter

要检查是否匹配的完整过滤器文本。

这个参数是必须的。
vars

要测试是否触发的JSON编码数组变量。

rcid

要检查是否触发的最近更改ID。

类型:整数
logid

用以检查的滥用过滤器日志ID。

类型:整数

action=abusefilterchecksyntax

  • 此模块需要读取权限。
  • 来源:Abuse Filter
  • 许可协议:GPL-2.0-or-later

检查一个防滥用过滤器的语法。

参数:
filter

要检查语法的完整过滤器文本。

这个参数是必须的。

action=abusefilterevalexpression

  • 此模块需要读取权限。
  • 来源:Abuse Filter
  • 许可协议:GPL-2.0-or-later

评估防滥用过滤器的表达式。

参数:
expression

要评估的表达式。

这个参数是必须的。
prettyprint

是否美化输出结果

类型:布尔型 (详情)

action=abusefilterunblockautopromote

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:Abuse Filter
  • 许可协议:GPL-2.0-or-later

从由于防滥用过滤器的结果而接受的autopromotions解封用户。

参数:
user

您希望解封的用户的用户名。

这个参数是必须的。
类型:通过 用户名、IP、IP范围和跨wiki用户名(例如“前缀>示例用户”) 中任意一种方式指定的用户
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=abuselogprivatedetails

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:Abuse Filter
  • 许可协议:GPL-2.0-or-later

显示一个AbuseLog入口的私有信息

参数:
logid

检查AbuseLog入口的ID

类型:整数
reason

执行检查的合理原因

token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。
例子:
使用“例子”这个原因,可以获取到带有ID 1 的AbuseLog入口的私有信息。
api.php?action=abuselogprivatedetails&logid=1&reason=example&token=ABC123 [在沙盒中打开]

action=ask

main | ask
  • 此模块需要读取权限。
  • 来源:Semantic MediaWiki
  • 许可协议:GPL-2.0-or-later

使用请求语言查询语义MediaWiki的API模块。

参数:
query
⧼apihelp-ask-param-query⧽
这个参数是必须的。
api_version

输出格式:

2
后端兼容格式,结果列表使用{}。
3
实验格式,结果列表使用[]。
以下值中的一个:2、3
默认:2

action=askargs

main | askargs
  • 此模块需要读取权限。
  • 来源:Semantic MediaWiki
  • 许可协议:GPL-2.0-or-later

使用请求语言作为条件、打印输出和参数的列表,来查询语义MediaWiki的API模块。

参数:
conditions
⧼apihelp-askargs-param-conditions⧽
这个参数是必须的。
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
printouts
⧼apihelp-askargs-param-printouts⧽
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
默认:(空)
parameters
⧼apihelp-askargs-param-parameters⧽
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
默认:(空)
api_version

输出格式:

2
后端兼容格式,结果列表使用{}。
3
实验格式,结果列表使用[]。
以下值中的一个:2、3
默认:2

action=block

main | block
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

封禁一位用户。

参数:
user

要封禁的用户。

类型:通过 用户名、IP、IP范围和用户ID(例如“#12345”) 中任意一种方式指定的用户
userid
已弃用。

改成指定user=#ID

类型:整数
expiry

到期时间。可以是相对时间(例如5 months2 weeks)或绝对时间(例如2014-09-18T12:34:56Z)。如果设置为infiniteindefinitenever,封禁将无限期。

默认:never
reason

封禁的原因。

默认:(空)
anononly

只封禁匿名用户(也就是说禁止此 IP 地址的匿名编辑)。

类型:布尔型 (详情)
nocreate

防止创建帐户。

类型:布尔型 (详情)
autoblock

自动封禁最近使用的IP地址,以及以后他们尝试登陆使用的IP地址。

类型:布尔型 (详情)
noemail

阻止用户通过wiki发送电子邮件。(需要blockemail权限)。

类型:布尔型 (详情)
hidename

从封禁日志中隐藏用户名。(需要hideuser权限)。

类型:布尔型 (详情)
allowusertalk

允许用户编辑自己的讨论页(取决于$wgBlockAllowsUTEdit)。

类型:布尔型 (详情)
reblock

如果该用户已被封禁,则覆盖已有的封禁。

类型:布尔型 (详情)
watchuser

监视用户或该 IP 的用户页和讨论页。

类型:布尔型 (详情)
tags

要在封禁日志中应用到实体的更改标签。

值(以|替代物分隔):
partial

封禁用户于特定页面或命名空间而不是整个站点。

类型:布尔型 (详情)
pagerestrictions

阻止用户编辑的标题列表。仅在partial设置为true时适用。

类型:页面标题
通过|替代物隔开各值。
值的最大值为10。
仅接受存在的页面。
namespacerestrictions

用于阻止用户编辑的命名空间ID列表。仅在partial设置为true时适用。

值(以|替代物分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
要指定所有值,请使用*
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=browsebyproperty

  • 此模块已弃用。
  • 此模块需要读取权限。
  • 来源:Semantic MediaWiki
  • 许可协议:GPL-2.0-or-later

检索有关某一属性,或是属性列表信息的API模块。

参数:
property
⧼apihelp-browsebyproperty-param-property⧽
limit
⧼apihelp-browsebyproperty-param-limit⧽
默认:50
lang
⧼apihelp-browsebyproperty-param-lang⧽
listonly
⧼apihelp-browsebyproperty-param-listonly⧽
默认:(空)

action=browsebysubject

  • 此模块已弃用。
  • 此模块需要读取权限。
  • 来源:Semantic MediaWiki
  • 许可协议:GPL-2.0-or-later

检索有关主题信息的API模块。

参数:
subject
⧼apihelp-browsebysubject-param-subject⧽
这个参数是必须的。
ns
⧼apihelp-browsebysubject-param-ns⧽
类型:整数
默认:0
iw
⧼apihelp-browsebysubject-param-iw⧽
默认:(空)
subobject
⧼apihelp-browsebysubject-param-subobject⧽
默认:(空)
type
⧼apihelp-browsebysubject-param-type⧽
默认:(空)
options
⧼apihelp-browsebysubject-param-options⧽
默认:(空)

action=categorytree

  • 此模块是内部或不稳定的。它的操作可以更改而不另行通知。
  • 此模块需要读取权限。
  • 来源:CategoryTree
  • 许可协议:GPL-2.0-or-later

用于CategoryTree扩展的内部模块。

参数:
category

分类名字空间中的标题,如果提供前缀将会被忽略。

这个参数是必须的。
options

用于CategoryTree构造器的选项,作为一个JSON对象。depth选项默认为1

action=changeauthenticationdata (changeauth)

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

更改当前用户的身份验证数据。

参数:
changeauthrequest

使用此身份验证请求,通过返回自action=query&meta=authmanagerinfoidamirequestsfor=change

这个参数是必须的。
changeauthtoken

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。
*
此模块允许额外参数,取决于可用的身份验证请求。使用action=query&meta=authmanagerinfoamirequestsfor=change(或之前来自此模块的相应,如果可以)以决定可用请求及其使用的字段。

action=changecontentmodel

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

变更页面的内容模型

参数:
title

需要更改其 contentmodel 的页面标题。不能与pageid一起使用。

pageid

需要更改其 contentmodel 的页面的页面 ID。不能与title一起使用。

类型:整数
summary

编辑概要和日志项原因

tags

更改标签来应用到日志项并编辑。

值(以|替代物分隔):
model

新内容的内容模型。

这个参数是必须的。
以下值中的一个:GadgetDefinition、Scribunto、css、javascript、json、smw/schema、text、wikitext
bot

使用机器人标志标记内容模型更改。

类型:布尔型 (详情)
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=checktoken

action=query&meta=tokens检查令牌有效性。

参数:
type

已开始测试的令牌类型。

这个参数是必须的。
以下值中的一个:createaccount、csrf、login、patrol、rollback、userrights、watch
token

要测试的令牌。

这个参数是必须的。
maxtokenage

令牌的最大允许年龄,以秒计。

类型:整数

action=cirrus-config-dump

  • 此模块需要读取权限。
  • 来源:CirrusSearch
  • 许可协议:GPL-2.0-or-later

CirrusSearch配置的转储。

参数:
prop

Type of configuration variables to dump

值(以|替代物分隔):globals、namespacemap、profiles、usertesting
默认:globals|namespacemap|profiles
例子:
获取CirrusSearch配置的转储。
api.php?action=cirrus-config-dump [在沙盒中打开]

action=cirrus-mapping-dump

  • 此模块需要读取权限。
  • 来源:CirrusSearch
  • 许可协议:GPL-2.0-or-later

用于此wiki的CirrusSearch映射转储。

例子:
获取用于此wiki的CirrusSearch映射转储。
api.php?action=cirrus-mapping-dump [在沙盒中打开]

action=cirrus-profiles-dump

  • 此模块需要读取权限。
  • 来源:CirrusSearch
  • 许可协议:GPL-2.0-or-later

此Wiki上的CirrusSearch配置文件转储。

参数:
verbose

获取配置文件内容

类型:布尔型 (详情)
例子:
获取此Wiki上的CirrusSearch配置文件转储。
api.php?action=cirrus-profiles-dump [在沙盒中打开]

action=cirrus-settings-dump

  • 此模块需要读取权限。
  • 来源:CirrusSearch
  • 许可协议:GPL-2.0-or-later

用于此wiki的CirrusSearch设置转储。

例子:
获取用于此wiki的CirrusSearch设置转储。
api.php?action=cirrus-settings-dump [在沙盒中打开]

action=clearhasmsg

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

清除当前用户的hasmsg标记。

例子:
清除当前用户的hasmsg标记。
api.php?action=clearhasmsg [在沙盒中打开]

action=clientlogin (login)

  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

使用交互式流登录wiki。

使用此模块的一般程序是:

  1. 通过amirequestsfor=login取得来自action=query&meta=authmanagerinfo的可用字段,和来自action=query&meta=tokenslogin令牌。
  2. 向用户显示字段,并获得其提交的内容。
  3. 发送(POST)至此模块,提供loginreturnurl及任何相关字段。
  4. 在响应中检查status
    • 如果您收到了PASS(成功)或FAIL(失败),则认为操作结束。成功与否如上句所示。
    • 如果您收到了UI,向用户显示新字段,并再次获取其提交的内容。然后再次使用logincontinue,向本模块提交相关字段,并重复第四步。
    • 如果您收到了REDIRECT,将用户指向redirecttarget中的目标,等待其返回loginreturnurl。然后再次使用logincontinue,向本模块提交返回URL中提供的一切字段,并重复第四步。
    • 如果您收到了RESTART,这意味着身份验证正常运作,但我们没有链接的用户账户。您可以将此看做UIFAIL
参数:
loginrequests

只使用这些身份验证请求,通过返回自action=query&meta=authmanagerinfoidamirequestsfor=login,或来自此模块之前的响应。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
loginmessageformat

用于返回消息的格式。

以下值中的一个:html、none、raw、wikitext
默认:wikitext
loginmergerequestfields

合并用于所有身份验证请求的字段信息至一个数组中。

类型:布尔型 (详情)
loginpreservestate

从之前失败的登录尝试中保持状态,如果可能。

类型:布尔型 (详情)
loginreturnurl

为第三方身份验证流返回URL,必须为绝对值。需要此值或logincontinue两者之一。

在接收REDIRECT响应时,您将代表性的打开浏览器或web视图到特定用于第三方身份验证流的redirecttarget URL。当它完成时,第三方将发生浏览器或web视图至此URL。您应当提取任何来自URL的查询或POST参数,并作为logincontinue请求传递至此API模块。

logincontinue

此请求是在早先的UIREDIRECT响应之后的附加请求。必填此值或loginreturnurl

类型:布尔型 (详情)
logintoken

action=query&meta=tokens取回的“login”令牌

这个参数是必须的。
*
此模块允许额外参数,取决于可用的身份验证请求。使用action=query&meta=authmanagerinfoamirequestsfor=login(或之前来自此模块的相应,如果可以)以决定可用请求及其使用的字段。

action=compare

main | compare

获取两页面之间的差异。

必须传递“from”和“to”之间的修订版本号、页面标题、页面ID、文本或相关参考资料。

参数:
fromtitle

要比较的第一个标题。

fromid

要比较的第一个页面 ID。

类型:整数
fromrev

要比较的第一个修订版本。

类型:整数
fromslots

覆盖由fromtitlefromidfromrev指定的修订版本。

此参数指定要修改的插槽。使用fromtext-{slot}fromcontentmodel-{slot}fromcontentformat-{slot}为每个插槽指定内容。

值(以|替代物分隔):main
fromtext-{slot}

指定间隔的文本。若忽略,该间隔将从修订中移除。

这是一个模板参数。当做出请求时,参数名中的{slot}应替换为fromslots的值。
fromsection-{slot}

fromtext-{slot}是单个章节的内容时,这是章节号。它将被合并到由fromtitlefromidfromrev指定的修订版本中,就像进行章节编辑一样。

这是一个模板参数。当做出请求时,参数名中的{slot}应替换为fromslots的值。
fromcontentformat-{slot}

fromtext-{slot}的内容序列化格式

这是一个模板参数。当做出请求时,参数名中的{slot}应替换为fromslots的值。
以下值中的一个:application/json、application/octet-stream、application/unknown、application/x-binary、text/css、text/javascript、text/plain、text/unknown、text/x-wiki、unknown/unknown
fromcontentmodel-{slot}

fromtext-{slot}的内容模型。如果未提供,则将根据其他参数进行猜测。

这是一个模板参数。当做出请求时,参数名中的{slot}应替换为fromslots的值。
以下值中的一个:GadgetDefinition、Scribunto、css、javascript、json、smw/schema、text、unknown、wikitext
frompst

fromtext-{slot}执行预保存转变。

类型:布尔型 (详情)
fromtext
已弃用。

指定fromslots=main并改用fromtext-main

fromcontentformat
已弃用。

指定fromslots=main并改用fromcontentformat-main

以下值中的一个:application/json、application/octet-stream、application/unknown、application/x-binary、text/css、text/javascript、text/plain、text/unknown、text/x-wiki、unknown/unknown
fromcontentmodel
已弃用。

指定fromslots=main并改用fromcontentmodel-main

以下值中的一个:GadgetDefinition、Scribunto、css、javascript、json、smw/schema、text、unknown、wikitext
fromsection
已弃用。

只使用指定“from”内容的指定章节。

totitle

要比较的第二个标题。

toid

要比较的第二个页面 ID。

类型:整数
torev

要比较的第二个修订版本。

类型:整数
torelative

使用与定义自fromtitlefromidfromrev的修订版本相关的修订版本。所有其他“to”的选项将被忽略。

以下值中的一个:cur、next、prev
toslots

覆盖由totitletoidtorev 指定的修订版本内容。

此参数指定要修改的插槽。使用totext-{slot}tocontentmodel-{slot}tocontentformat-{slot}为每个插槽指定内容。

值(以|替代物分隔):main
totext-{slot}

指定插槽的文本。如果省略,则从修订版本中删除该插槽。

这是一个模板参数。当做出请求时,参数名中的{slot}应替换为toslots的值。
tosection-{slot}

totext-{slot}是单个章节的内容时,这是章节号。它将被合并到由totitletoidtorev指定的修订版本中,就像进行章节编辑一样。

这是一个模板参数。当做出请求时,参数名中的{slot}应替换为toslots的值。
tocontentformat-{slot}

totext-{slot}的内容序列化格式。

这是一个模板参数。当做出请求时,参数名中的{slot}应替换为toslots的值。
以下值中的一个:application/json、application/octet-stream、application/unknown、application/x-binary、text/css、text/javascript、text/plain、text/unknown、text/x-wiki、unknown/unknown
tocontentmodel-{slot}

totext-{slot}的内容模型。如果未提供,则将根据其他参数进行猜测。

这是一个模板参数。当做出请求时,参数名中的{slot}应替换为toslots的值。
以下值中的一个:GadgetDefinition、Scribunto、css、javascript、json、smw/schema、text、unknown、wikitext
topst

totext执行预保存转换。

类型:布尔型 (详情)
totext
已弃用。

指定 fromslots=main 并改用 totext-main

tocontentformat
已弃用。

指定toslots=main并改用tocontentformat-main

以下值中的一个:application/json、application/octet-stream、application/unknown、application/x-binary、text/css、text/javascript、text/plain、text/unknown、text/x-wiki、unknown/unknown
tocontentmodel
已弃用。

指定toslots=main的内容模型并改用tocontentmodel-main

以下值中的一个:GadgetDefinition、Scribunto、css、javascript、json、smw/schema、text、unknown、wikitext
tosection
已弃用。

只使用指定“to”内容的指定章节。

prop

要获取的信息束。

diff
差异HTML。
diffsize
差异HTML的大小(字节)。
rel
“from”之前及“to”之后修订版本的修订ID,如果有。
ids
“from”和“to”修订版本的页面及修订ID。
title
“from”和“to”修订版本的页面标题。
user
“from”和“to”修订版本的用户名和 ID。若该用户已被删除修订,将返回fromuserhiddentouserhidden属性。
comment
“from”和“to”修订版本的注释。若该注释已被删除修订,将返回fromcommenthiddentocommenthidden属性。
parsedcomment
“from”和“to”修订版本的已解析注释。若该注释已被删除修订,将返回fromcommenthiddentocommenthidden属性。
size
“from”和“to”修订版本的大小。
timestamp
(没有说明)
值(以|替代物分隔):comment、diff、diffsize、ids、parsedcomment、rel、size、timestamp、title、user
默认:diff|ids|title
slots

返回这些间隔的个别差异,而非所有间隔合并而得到的单个差异。

值(以|替代物分隔):main
要指定所有值,请使用*
例子:
在版本1和2中创建差异。
api.php?action=compare&fromrev=1&torev=2 [在沙盒中打开]

action=createaccount (create)

  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

创建一个新用户账户。

使用此模块的一般程序是:

  1. 通过amirequestsfor=create取得来自action=query&meta=authmanagerinfo的可用字段,和来自action=query&meta=tokenscreateaccount令牌。
  2. 向用户显示字段,并获得其提交的内容。
  3. 发送(POST)至此模块,提供createreturnurl及任何相关字段。
  4. 在响应中检查status
    • 如果您收到了PASS(成功)或FAIL(失败),则认为操作结束。成功与否如上句所示。
    • 如果您收到了UI,向用户显示新字段,并再次获取其提交的内容。然后再次使用createcontinue,向本模块提交相关字段,并重复第四步。
    • 如果您收到了REDIRECT,将用户指向redirecttarget中的目标,等待其返回createreturnurl。然后再次使用createcontinue,向本模块提交返回URL中提供的一切字段,并重复第四步。
    • 如果您收到了RESTART,这意味着身份验证正常运作,但我们没有链接的用户账户。您可以将此看做UIFAIL
参数:
createrequests

只使用这些身份验证请求,通过返回自action=query&meta=authmanagerinfoidamirequestsfor=create,或来自此模块之前的响应。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
createmessageformat

用于返回消息的格式。

以下值中的一个:html、none、raw、wikitext
默认:wikitext
createmergerequestfields

合并用于所有身份验证请求的字段信息至一个数组中。

类型:布尔型 (详情)
createpreservestate

从之前失败的登录尝试中保持状态,如果可能。

如果action=query&meta=authmanagerinfo返回用于hasprimarypreservedstate的真值,标记为primary-required的请求应被忽略。如果它返回用于preservedusername的非空值,用户名必须用于username参数。

类型:布尔型 (详情)
createreturnurl

为第三方身份验证流返回URL,必须为绝对值。需要此值或createcontinue两者之一。

在接收REDIRECT响应时,您将代表性的打开浏览器或web视图到特定用于第三方身份验证流的redirecttarget URL。当它完成时,第三方将发生浏览器或web视图至此URL。您应当提取任何来自URL的查询或POST参数,并作为createcontinue请求传递至此API模块。

createcontinue

此请求是在早先的UIREDIRECT响应之后的附加请求。必填此值或createreturnurl

类型:布尔型 (详情)
createtoken

action=query&meta=tokens取回的“createaccount”令牌

这个参数是必须的。
*
此模块允许额外参数,取决于可用的身份验证请求。使用action=query&meta=authmanagerinfoamirequestsfor=create(或之前来自此模块的相应,如果可以)以决定可用请求及其使用的字段。

action=cspreport

main | cspreport
  • 此模块是内部或不稳定的。它的操作可以更改而不另行通知。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

由浏览器使用以报告违反内容安全方针的内容。此模块应永不使用,除了在被CSP兼容的浏览器自动使用时。

参数:
reportonly

标记作为来自监视方针的报告,而不是执行方针的报告

类型:布尔型 (详情)
source

生成引发此报告的CSP标头的事物

默认:internal

action=delete

main | delete
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

删除一个页面。

参数:
title

要删除的页面标题。不能与pageid一起使用。

pageid

要删除的页面的页面 ID。不能与title一起使用。

类型:整数
reason

删除原因。如果未设置,将使用一个自动生成的原因。

tags

要在删除日志中应用到实体的更改标签。

值(以|替代物分隔):
watch
已弃用。

将该页面加入当前用户的监视列表。

类型:布尔型 (详情)
watchlist

无条件地将页面加入至当前用户的监视列表或将其移除(忽略机器人用户),使用设置或不更改监视。

以下值中的一个:nochange、preferences、unwatch、watch
默认:preferences
unwatch
已弃用。

将该页面从当前用户的监视列表删除。

类型:布尔型 (详情)
oldimage

action=query&prop=imageinfo&iiprop=archivename提供的要删除的旧图片名称。

token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=echomarkread

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:Echo
  • 许可协议:MIT

对当前用户标记通知为已读。

参数:
list

要标记已读的通知ID列表。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
unreadlist

要标记未读的通知ID列表。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
all

如果设置,标记一位用户的所有通知为已读。

类型:布尔型 (详情)
sections

要标记为已读的部分列表。

值(以|替代物分隔):alert、message
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=echomarkseen

  • 此模块需要读取权限。
  • 来源:Echo
  • 许可协议:MIT

对当前用户标记通知为已读。

参数:
type

要标记为已读的通知类型:“alert”、“message”或“all”。

这个参数是必须的。
以下值中的一个:alert、all、message
timestampFormat

用于输出的时间戳格式,“ISO_8601”或“MW”。“MW”在此被弃用,因此所有客户端应切换为“ISO_8601”。此参数将被移除,且“ISO_8601”将成为唯一的输出格式。

以下值中的一个:ISO_8601、MW
默认:MW
例子:
标记所有类型的通知为已读
api.php?action=echomarkseen&type=all [在沙盒中打开]

action=echomute

main | echomute
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:Echo
  • 许可协议:MIT

将来自某些用户或页面的通知静音或取消静音。

参数:
type

要添加或移除的静音列表

这个参数是必须的。
以下值中的一个:page-linked-title、user
mute

要添加到屏蔽列表的页面或用户

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
unmute

要从静音列表中移除的页面或用户

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=edit

main | edit
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

创建和编辑页面。

参数:
title

要编辑的页面标题。不能与pageid一起使用。

pageid

要编辑的页面的页面 ID。不能与title一起使用。

类型:整数
section

段落数。0用于首段,new用于新的段落。

sectiontitle

新段落的标题。

text

页面内容。

summary

编辑摘要。当section=new且未设置sectiontitle时,还包括小节标题。

tags

应用到此修订的更改标签。

值(以|替代物分隔):
minor

将此次编辑标记为小编辑

类型:布尔型 (详情)
notminor

不将该编辑标记为小编辑,即使“默认标记所有编辑为小编辑”用户偏好设置已被设置。

类型:布尔型 (详情)
bot

标记此编辑为机器人编辑。

类型:布尔型 (详情)
baserevid

基础修订的 ID,用于检测编辑冲突。可使用action=query&prop=revisions来获得。自我冲突会导致编辑失败,除非 basetimestamp 已设置。

类型:整数
basetimestamp

基础修订的时间戳,用于检测编辑冲突。可以通过action=query&prop=revisions&rvprop=timestamp得到。会忽略自我冲突。

类型:时间戳(允许格式
starttimestamp

编辑过程开始的时间戳,用于检测编辑冲突。当开始编辑过程时(例如当加载要编辑的页面时)使用curtimestamp可能取得一个适当的值。

类型:时间戳(允许格式
recreate

覆盖有关该页面在此期间已被删除的任何错误。

类型:布尔型 (详情)
createonly

不要编辑页面,如果已经存在。

类型:布尔型 (详情)
nocreate

如果该页面不存在,则抛出一个错误。

类型:布尔型 (详情)
watch
已弃用。

将页面加入当前用户的监视列表。

类型:布尔型 (详情)
unwatch
已弃用。

将页面从当前用户的监视列表中移除。

类型:布尔型 (详情)
watchlist

无条件地将页面加入至当前用户的监视列表或将其移除(忽略机器人用户),使用设置或不更改监视。

以下值中的一个:nochange、preferences、unwatch、watch
默认:preferences
md5

text参数或prependtext和appendtext级联参数的MD5哈希值。如果设置,除非哈希值正确否则编辑无法完成。

prependtext

将该文本添加到该页面的开始。覆盖text。

appendtext

将该文本添加到该页面的结尾。覆盖text。

采用section=new来添加一个新的章节,而不是这个参数。

undo

撤销此次修订。覆盖text、prependtext和appendtext。

类型:整数
值必须不少于0。
undoafter

撤销从undo至此的所有修订。如果不设置就撤销一次修订。

类型:整数
值必须不少于0。
redirect

自动解决重定向。

类型:布尔型 (详情)
contentformat

用于输入文本的内容序列化格式。

以下值中的一个:application/json、application/octet-stream、application/unknown、application/x-binary、text/css、text/javascript、text/plain、text/unknown、text/x-wiki、unknown/unknown
contentmodel

新内容的内容模型。

以下值中的一个:GadgetDefinition、Scribunto、css、javascript、json、smw/schema、text、unknown、wikitext
token

action=query&meta=tokens取回的“csrf”令牌

令牌应总是发送为最后参数,或至少在text参数之后。

这个参数是必须的。
captchaword

回答验证码

captchaid

之前请求的验证码ID

action=emailuser

main | emailuser
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

电子邮件联系一位用户。

参数:
target

电子邮件的目标用户。

这个参数是必须的。
subject

主题页眉。

text

邮件正文。

这个参数是必须的。
ccme

给我发送一份该邮件的副本。

类型:布尔型 (详情)
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。
例子:
向用户WikiSysop发送邮件,带文字Content
api.php?action=emailuser&target=WikiSysop&text=Content&token=123ABC [在沙盒中打开]

action=expandtemplates

展开wikitext中的所有模板。

参数:
title

页面标题。

text

要转换的wikitext。

这个参数是必须的。
revid

修订版本ID,用于{{REVISIONID}}和类似变体。

类型:整数
prop

要获取的那条信息。

注意如果没有选定值,结果将包含wikitext,但将以弃用的格式显示。

wikitext
展开后的wikitext。
categories
任何在输出中提供的,未在wikitext输出中表现的分类。
properties
由wikitext中扩充的魔术字定义的页面属性。
volatile
输出是否常常变动,是否不应被在页面中其他任何位置重用。
ttl
结果缓存应无效化后的最长时间。
modules
任何解析器函数请求添加至输出的ResourceLoader模块。jsconfigvarsencodedjsconfigvars之一必须与modules共同被请求。
jsconfigvars
针对页面提供JavaScript配置变量。
encodedjsconfigvars
针对页面提供JavaScript配置变量为一个JSON字符串。
parsetree
输入的XML分析树。
值(以|替代物分隔):categories、encodedjsconfigvars、jsconfigvars、modules、parsetree、properties、ttl、volatile、wikitext
includecomments

输出时是否包含HTML注释。

类型:布尔型 (详情)
generatexml
已弃用。

生成XML解析树(取代自prop=parsetree)。

类型:布尔型 (详情)

action=ext.srf.slideshow.show

  • 此模块需要读取权限。
  • 来源:Semantic Result Formats
  • 许可协议:GPL-2.0-or-later
⧼apihelp-ext.srf.slideshow.show-summary⧽
参数:
pageid
⧼apihelp-ext.srf.slideshow.show-param-pageid⧽
这个参数是必须的。
类型:整数
template
⧼apihelp-ext.srf.slideshow.show-param-template⧽
这个参数是必须的。
printouts
⧼apihelp-ext.srf.slideshow.show-param-printouts⧽
默认:[]

action=feedcontributions

返回用户贡献纲要。

参数:
feedformat

纲要的格式。

以下值中的一个:atom、rss
默认:rss
user

获取哪些用户的贡献。

这个参数是必须的。
类型:通过 用户名、IP、IP范围、跨wiki用户名(例如“前缀>示例用户”)和用户ID(例如“#12345”) 中任意一种方式指定的用户
namespace

过滤哪些命名空间的贡献。

以下值中的一个:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
year

起始年份(及更早)。

类型:整数
month

起始月份(及更早)。

类型:整数
tagfilter

过滤有这些标签的贡献者。

值(以|替代物分隔):abusefilter-condition-limit、advanced mobile edit、mobile edit、mobile web edit、moderation-merged、mw-add-media、mw-blank、mw-changed-redirect-target、mw-contentmodelchange、mw-manual-revert、mw-new-redirect、mw-remove-media、mw-removed-redirect、mw-replace、mw-reverted、mw-rollback、mw-server-side-upload、mw-undo
默认:(空)
deletedonly

仅显示已删除的贡献。

类型:布尔型 (详情)
toponly

仅仅显示那些作为最新修订的编辑。

类型:布尔型 (详情)
newonly

仅仅显示那些作为页面创建的编辑。

类型:布尔型 (详情)
hideminor

隐藏小编辑。

类型:布尔型 (详情)
showsizediff

显示修订版本之间的大小差别。

类型:布尔型 (详情)

action=feedrecentchanges

返回最近更改的摘要。

参数:
feedformat

纲要的格式。

以下值中的一个:atom、rss
默认:rss
namespace

用于限制结果的命名空间。

以下值中的一个:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
invert

除所选定者外的所有命名空间。

类型:布尔型 (详情)
associated

包括相关的命名空间(讨论页或主要)。

类型:布尔型 (详情)
days

用于限制结果的天数。

类型:整数
值必须不少于1。
默认:7
limit

所要返回结果的最大数目。

类型:整数
值必须介于1和50之间。
默认:50
from

显示自那时以来的更改。

类型:时间戳(允许格式
hideminor

隐藏小更改。

类型:布尔型 (详情)
hidebots

隐藏机器人所做的更改。

类型:布尔型 (详情)
hideanons

隐藏匿名用户做出的更改。

类型:布尔型 (详情)
hideliu

隐藏注册用户做出的更改。

类型:布尔型 (详情)
hidepatrolled

隐藏已巡查更改。

类型:布尔型 (详情)
hidemyself

隐藏当前用户做出的更改。

类型:布尔型 (详情)
hidecategorization

隐藏分类成员更改。

类型:布尔型 (详情)
tagfilter

按标签过滤。

target

仅仅显示从该页面链出的那些页面的变更。

showlinkedto

仅仅显示链入到该页面的那些页面的变更。

类型:布尔型 (详情)

action=feedwatchlist

返回监视列表纲要。

参数:
feedformat

纲要的格式。

以下值中的一个:atom、rss
默认:rss
hours

列出从现在起数小时内修改的页面。

类型:整数
值必须介于1和72之间。
默认:24
linktosections

如果可能的话,直接链接到已变更的小节。

类型:布尔型 (详情)
allrev

将同一页面的多个修订包含于指定的时间表内。

类型:布尔型 (详情)
wlowner

与token一起使用以访问不同用户的监视列表。

类型:通过 用户名 方式指定的用户
wltoken

允许访问其他用户监视列表的安全密钥(可通过用户的参数设置找到)。

wlshow

只显示满足这些标准的项目。例如,要只查看由登录用户做出的小编辑,设置show=minor|!anon。

值(以|替代物分隔):!anon、!autopatrolled、!bot、!minor、!patrolled、!unread、anon、autopatrolled、bot、minor、patrolled、unread
wltype

要显示的更改类型:

edit
普通页面编辑。
new
页面创建。
log
日志记录。
external
外部更改。
categorize
分类成员组更改。
值(以|替代物分隔):categorize、edit、external、log、new
默认:edit|new|log|categorize
wlexcludeuser

不要列出此用户的更改。

类型:通过 用户名、IP、跨wiki用户名(例如“前缀>示例用户”)和用户ID(例如“#12345”) 中任意一种方式指定的用户
例子:
显示监视列表订阅。
api.php?action=feedwatchlist [在沙盒中打开]
显示过去6小时内受监视页面的所有更改。
api.php?action=feedwatchlist&allrev=&hours=6 [在沙盒中打开]

action=filerevert

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

回退一个文件至某一旧版本。

参数:
filename

目标文件名,不包含前缀“File:”。

这个参数是必须的。
comment

上传评论。

默认:(空)
archivename

恢复到修订版存档名称。

这个参数是必须的。
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=flowthread

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:FlowThread
  • 许可协议:BSD-2-Clause
⧼apihelp-flowthread-summary⧽
参数:
type

需要进行的操作。(必须为 list, like, dislike, report, delete, recover, erase, markchecked 或 post 其中一项)

这个参数是必须的。
pageid

要进行评论 (type = post),或者要列举评论 (type = list) 的页面的ID。对于 post 和 list 操作来说是必须的。

类型:整数
postid

要进行操作 (type = like, dislike, report, delete, recover, erase, markchecked),或者要回复 (type = post) 的评论的ID。在前一种情况下是必须的。

content

要发表的评论的内容。对于 post 操作是必须的。

wikitext

指明发表的内容是否应当被作为维基文本处理。

类型:布尔型 (详情)
offset

开始列举评论的偏移。

类型:整数
limit

列举评论的数量上限。设置为 'max' 时列举当前页面的所有评论。

类型:整数
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=help

main | help

显示指定模块的帮助。

参数:
modules

用于显示帮助的模块(actionformat参数值,或main)。可通过+指定子模块。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
默认:main
submodules

包括给定名称模块的子模块的帮助。

类型:布尔型 (详情)
recursivesubmodules

包括递归子模块的帮助。

类型:布尔型 (详情)
wrap

在一个标准API响应结构中包裹输出。

类型:布尔型 (详情)
toc

在HTML输出中包括目录。

类型:布尔型 (详情)

action=imagerotate

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

旋转一幅或多幅图像。

参数:
rotation

顺时针旋转图像的度数。

这个参数是必须的。
以下值中的一个:90、180、270
continue

当更多结果可用时,使用这个继续。

tags

要在上传日志中应用到实体的标签。

值(以|替代物分隔):
titles

要工作的标题列表。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
pageids

要工作的页面ID列表。

类型:整数列表
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
revids

要工作的修订ID列表。

类型:整数列表
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
generator

通过执行指定查询模块获得页面列表以工作。

注意:发生器参数名称必须以“g”开头,参见例子。

allcategories
列举所有分类。
alldeletedrevisions
列举由一位用户或在一个命名空间中所有已删除的修订。
allfileusages
列出所有文件用途,包括不存在的。
allimages
按顺序枚举所有图像。
alllinks
列举所有指向至指定命名空间的链接。
allpages
循序列举在指定命名空间中的所有页面。
allredirects
列出至一个命名空间的重定向。
allrevisions
列举所有修订。
alltransclusions
列出所有嵌入页面(使用{{x}}嵌入的页面),包括不存在的。
backlinks
查找所有链接至指定页面的页面。
categories
页面属于的所有分类列表。
categorymembers
在指定的分类中列出所有页面。
deletedrevisions
获取删除的修订版本信息。
duplicatefiles
根据哈希值列出此给定文件的所有副本。
embeddedin
查找所有嵌入指定标题的页面。
exturlusage
列举包含一个指定URL的页面。
fileusage
查找所有使用指定文件的页面。
images
返回指定页面上包含的所有文件。
imageusage
查找所有使用指定图片标题的页面。
iwbacklinks
查找所有链接至指定跨wiki链接的页面。
langbacklinks
查找所有链接至指定语言链接的页面。
links
从指定页面返回所有链接。
linkshere
查找所有链接至指定页面的页面。
pageswithprop
列出所有使用指定页面属性的页面。
prefixsearch
为页面标题执行前缀搜索。
protectedtitles
列出所有被限制创建的标题。
querypage
获取由基于QueryPage的特殊页面提供的列表。
random
获取随机页面集。
recentchanges
列举最近更改。
redirects
返回至指定页面的所有重定向。
revisions
获取修订版本信息。
search
执行一次全文本搜索。
templates
返回指定页面上所有被嵌入的页面。
transcludedin
查找所有嵌入指定页面的页面。
watchlist
在当前用户的监视列表中获取对页面的最近更改。
watchlistraw
获得当前用户的监视列表上的所有页面。
以下值中的一个:allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

自动解决在titlespageidsrevids,以及在由generator返回的页面中的重定向。

类型:布尔型 (详情)
converttitles

如有需要,将标题转换为其他变体。只有当wiki的内容语言支持变体转换时才能工作。支持变体转换的语言包括ban、en、crh、gan、iu、kk、ku、shi、sr、tg、uz和zh。

类型:布尔型 (详情)
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=import

main | import
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

从其他wiki,或从XML文件导入页面。

注意当发送用于xml参数的文件时,HTTP POST必须作为文件上传完成(即使用multipart/form-data)

参数:
summary

日志记录导入摘要。

xml

上传的XML文件。

必须使用POST方法及multipart/form-data作为文件上传。
interwikiprefix

对于上传导入:要应用到位置用户名的跨wiki前缀(如果设置了assignknownusers的话,则也包含已知用户)。

interwikisource

用于跨wiki导入:导入的来源wiki。

以下值中的一个:
interwikipage

用于跨wiki导入:导入的页面。

fullhistory

用于跨wiki导入:完整导入历史,而不只是最新版本。

类型:布尔型 (详情)
templates

用于跨wiki导入:连带导入所有包含的模板。

类型:布尔型 (详情)
namespace

导入至此命名空间。不能与rootpage一起使用。

以下值中的一个:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
assignknownusers

分配编辑至本地用户,只要命名用户存在于本地。

类型:布尔型 (详情)
rootpage

作为此页面的子页面导入。不能与namespace一起使用。

tags

要在导入日志,以及在导入页面的空修订版本中应用到实体的更改标签。

值(以|替代物分隔):
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=linkaccount (link)

  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

将来自第三方提供商的账户链接至当前用户。

使用此模块的一般程序是:

  1. 通过amirequestsfor=link取得来自action=query&meta=authmanagerinfo的可用字段,和来自action=query&meta=tokenscsrf令牌。
  2. 向用户显示字段,并获得其提交的内容。
  3. 发送(POST)至此模块,提供linkreturnurl及任何相关字段。
  4. 在响应中检查status
    • 如果您收到了PASS(成功)或FAIL(失败),则认为操作结束。成功与否如上句所示。
    • 如果您收到了UI,向用户显示新字段,并再次获取其提交的内容。然后再次使用linkcontinue,向本模块提交相关字段,并重复第四步。
    • 如果您收到了REDIRECT,将用户指向redirecttarget中的目标,等待其返回linkreturnurl。然后再次使用linkcontinue,向本模块提交返回URL中提供的一切字段,并重复第四步。
    • 如果您收到了RESTART,这意味着身份验证正常运作,但我们没有链接的用户账户。您可以将此看做UIFAIL
参数:
linkrequests

只使用这些身份验证请求,通过返回自action=query&meta=authmanagerinfoidamirequestsfor=link,或来自此模块之前的响应。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
linkmessageformat

用于返回消息的格式。

以下值中的一个:html、none、raw、wikitext
默认:wikitext
linkmergerequestfields

合并用于所有身份验证请求的字段信息至一个数组中。

类型:布尔型 (详情)
linkreturnurl

为第三方身份验证流返回URL,必须为绝对值。需要此值或linkcontinue两者之一。

在接收REDIRECT响应时,您将代表性的打开浏览器或web视图到特定用于第三方身份验证流的redirecttarget URL。当它完成时,第三方将发生浏览器或web视图至此URL。您应当提取任何来自URL的查询或POST参数,并作为linkcontinue请求传递至此API模块。

linkcontinue

此请求是在早先的UIREDIRECT响应之后的附加请求。必填此值或linkreturnurl

类型:布尔型 (详情)
linktoken

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。
*
此模块允许额外参数,取决于可用的身份验证请求。使用action=query&meta=authmanagerinfoamirequestsfor=link(或之前来自此模块的相应,如果可以)以决定可用请求及其使用的字段。

action=login (lg)

main | login
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

登录并获取身份验证cookie。

此操作只应与Special:BotPasswords一起使用;用于主账户登录的方式已弃用,并可能在没有警告的情况下失败。要安全登录主账户,请使用action=clientlogin

参数:
lgname

用户名。

lgpassword

密码。

lgdomain

域名(可选)。

lgtoken

action=query&meta=tokens取回的“login”令牌

action=logout

main | logout
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

退出并清除会话数据。

参数:
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=managetags

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

执行有关更改标签的管理任务。

参数:
operation

要执行哪个操作:

create
创建一个新的更改标签供手动使用。
delete
从数据库中移除一个更改标签,包括移除已使用在所有修订版本、最近更改记录和日志记录上的该标签。
activate
激活一个更改标签,允许用户手动应用它。
deactivate
停用一个更改标签,阻止用户手动应用它。
这个参数是必须的。
以下值中的一个:activate、create、deactivate、delete
tag

要创建、删除、激活或取消激活的标签。要创建标签,标签必须不存在。要删除标签,标签必须存在。要激活标签,标签必须存在,且不被任何扩展使用。要取消激活标签,标签必须当前处于激活状态,且被手动定义。

这个参数是必须的。
reason

一个创建、删除、激活或停用标签时的原因,可选。

ignorewarnings

是否忽略操作期间发生的任何警告。

类型:布尔型 (详情)
tags

要在标签管理日志中应用到实体的更改标签。

值(以|替代物分隔):
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=mergehistory

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

合并页面历史。

参数:
from

将被合并历史的页面的标题。不能与fromid一起使用。

fromid

将被合并历史的页面的页面ID。不能与from一起使用。

类型:整数
to

将要合并历史的页面的标题。不能与toid一起使用。

toid

将要合并历史的页面的页面ID。不能与to一起使用。

类型:整数
timestamp

指定时间戳,决定源页面的哪些修订历史被移动到目标页面的历史中。如果省略,源页面的所有历史记录都将被合并到目标页面。

类型:时间戳(允许格式
reason

历史合并的原因。

默认:(空)
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=mobileview

  • 此模块已弃用。
  • 此模块需要读取权限。
  • 来源:MobileFrontend
  • 许可协议:GPL-2.0-or-later

返回移动浏览需要的数据。

参数:
page

待处理的页面标题。

这个参数是必须的。
redirect

是否允许重定向。

以下值中的一个:no、yes
默认:yes
sections

用于返回文本的逗号分隔的段数列表。“all”可用于返回所有的。格式范围“1-4”是指获取1、2、3、4段。没有指定第二个数字的范围,例如“1-”意思是获取所有直到末尾。“references”可被用于指定所有包含参考资料的段落应该被返回。

prop

要获得的信息:

text
选定段落的HTML。
sections
有关页面上所有段落的信息。
normalizedtitle
标准化的页面标题。
lastmodified
页面最近修改时的 ISO 8601 时间戳,例如“2014-04-13T22:42:14Z”。
lastmodifiedby
有关最近修改页面的用户的信息。
revision
返回页面的当前修订版本ID。
protection
有关保护级别的信息。
editable
当前用户是否可以编辑此页面。这考虑所有用于登录用户的因素,但不考虑匿名用户的封禁状态。
languagecount
此页面可用的语言数。
hasvariants
此页面在其他语言变体中是否可用。
displaytitle
页面的渲染标题,{{DISPLAYTITLE}}等代码生效。
pageprops
页面属性。
值(以|替代物分隔):contentmodel、description、displaytitle、editable、hasvariants、id、languagecount、lastmodified、lastmodifiedby、namespace、normalizedtitle、pageprops、protection、revision、sections、text
默认:text|sections|normalizedtitle
sectionprop

要获取的有关操作的信息。

值(以|替代物分隔):anchor、fromtitle、index、level、line、number、toclevel
默认:toclevel|line
pageprops

返回的页面属性,竖线(“|”)分隔列表或“*”对于所有属性。

默认:notoc|noeditsection|wikibase_item
variant

转换内容至这种语言变体。

默认:(空)
noheadings

输出时不包含标题。

类型:布尔型 (详情)
notransform

不要改变HTML至移动适配版。

类型:布尔型 (详情)
onlyrequestedsections

只返回请求的与prop=sections一样的段落。

类型:布尔型 (详情)
offset

假装所有文本结果是一个字符串,并返回此点位开始的子字符串。

类型:整数
值必须不少于0。
默认:0
maxlen

假装所有文本结果是一个字符串,并限制结果至此长度。

类型:整数
值必须不少于0。
默认:0
revision

请求一个特定修订版本。

类型:整数
值必须不少于0。
默认:0
例子:
获取有关Doom metal的第0章节的信息
api.php?action=mobileview&page=Doom_metal&sections=0 [在沙盒中打开]
获取有关第0节和包含Candlemass的参考资料的段落的信息
api.php?action=mobileview&page=Candlemass&sections=0|references [在沙盒中打开]
获得有关第1节及以后,和包含Candlemass的参考资料的段落的信息
api.php?action=mobileview&page=Candlemass&sections=1-|references [在沙盒中打开]

action=moderation

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:Moderation
  • 许可协议:GPL-3.0+

Performs moderation-related action like Approve or Reject.

参数:
modaction

Moderation-related action to perform.

这个参数是必须的。
以下值中的一个:approve、approveall、block、reject、rejectall、show、unblock
modid

ID of the pending change.

这个参数是必须的。
类型:整数
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=move

main | move
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

移动一个页面。

参数:
from

要重命名的页面标题。不能与fromid一起使用。

fromid

您希望移动的页面ID。不能与from一起使用。

类型:整数
to

页面重命名的目标标题。

这个参数是必须的。
reason

重命名的原因。

默认:(空)
movetalk

重命名讨论页,如果存在。

类型:布尔型 (详情)
movesubpages

重命名子页面,如果可以。

类型:布尔型 (详情)
noredirect

不要创建重定向。

类型:布尔型 (详情)
watchlist

无条件地将页面加入至当前用户的监视列表或将其移除(忽略机器人用户),使用设置或不更改监视。

以下值中的一个:nochange、preferences、unwatch、watch
默认:preferences
ignorewarnings

忽略任何警告。

类型:布尔型 (详情)
tags

要在移动日志,以及在目标页面的空修订版本中应用到实体的更改标签。

值(以|替代物分隔):
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=newpagenumber

  • 此模块需要读取权限。
  • 来源:NewPageNumber
  • 许可协议:GFDL-1.2
⧼apihelp-newpagenumber-summary⧽
参数:
gameId
⧼apihelp-newpagenumber-param-gameId⧽
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
默认:(空)
action
⧼apihelp-newpagenumber-param-action⧽
这个参数是必须的。
以下值中的一个:newpagenumber

action=opensearch

使用开放搜索协议搜索wiki。

参数:
search

搜索字符串。

这个参数是必须的。
namespace

搜索的命名空间。如果search以有效命名空间前缀开头则忽略。

值(以|替代物分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
要指定所有值,请使用*
默认:0
limit

要返回的结果最大数。

类型:整数或max
值必须介于1和500之间。
默认:10
suggest
已弃用。

已被弃用。

类型:布尔型 (详情)
redirects

如何处理重定向:

return
返回重定向本身。
resolve
返回目标页面。可能返回少于limit个结果。

由于历史原因,format=json默认为"return",其他格式默认为"resolve"。

以下值中的一个:resolve、return
format

输出格式。

以下值中的一个:json、jsonfm、xml、xmlfm
默认:json
warningsaserror

如果警告通过format=json提升,返回一个API错误而不是忽略它们。

类型:布尔型 (详情)
例子:
查找以Te开头的页面。
api.php?action=opensearch&search=Te [在沙盒中打开]

action=options

main | options
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

更改当前用户的参数设置。

只有注册在核心或者已安装扩展中的选项,或者具有userjs-键值前缀(旨在使用于用户脚本)的选项可设置。

参数:
reset

将参数设置重置为网站默认值。

类型:布尔型 (详情)
resetkinds

reset选项被设置时,要重置的选项类型列表。

值(以|替代物分隔):all、registered、registered-checkmatrix、registered-multiselect、special、unused、userjs
默认:all
change

更改列表,以name=value格式化(例如skin=vector)。如果没提供值(甚至没有等号),例如optionname|otheroption|...,选项将重置为默认值。如果任何传递的值包含管道字符(|),请改用替代多值分隔符以正确操作。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
optionname

应设置为由optionvalue提供值的选项名称。

optionvalue

用于由optionname指定的选项的值。

userId
⧼apihelp-options-param-userId⧽
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=paraminfo

main | paraminfo

获得关于API模块的信息。

参数:
modules

模块名称(actionformat参数值,或main)的列表。可通过+指定子模块,或通过+*指定所有子模块,或通过+**指定所有递归子模块。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
helpformat

帮助字符串的格式。

以下值中的一个:html、none、raw、wikitext
默认:none
querymodules
已弃用。

查询模块名称(propmetalist参数值)的列表。使用modules=query+foo而不是querymodules=foo

值(以|替代物分隔):abusefilters、abuselog、allcategories、alldeletedrevisions、allfileusages、allimages、alllinks、allmessages、allpages、allredirects、allrevisions、alltransclusions、allusers、authmanagerinfo、backlinks、blocks、categories、categoryinfo、categorymembers、cirrusbuilddoc、cirruscompsuggestbuilddoc、cirrusdoc、contributors、deletedrevisions、deletedrevs、duplicatefiles、embeddedin、extlinks、exturlusage、filearchive、filerepoinfo、fileusage、gadgetcategories、gadgets、imageinfo、images、imageusage、info、iwbacklinks、iwlinks、langbacklinks、langlinks、languageinfo、links、linkshere、logevents、moderationpreload、mystashedfiles、notifications、pagepropnames、pageprops、pageswithprop、prefixsearch、protectedtitles、querypage、random、recentchanges、redirects、revisions、search、siteinfo、stashimageinfo、tags、templates、tokens、transcludedin、unreadnotificationpages、usercontribs、userinfo、users、watchlist、watchlistraw
值的最大值为50(允许更高上限的客户端为500)。
mainmodule
已弃用。

获取有关主要(最高级)模块的信息。也可使用modules=main

pagesetmodule
已弃用。

获取有关页面设置模块(提供titles=和朋友)的信息。

formatmodules
已弃用。

格式模块名称(format参数的值)的列表。也可使用modules

值(以|替代物分隔):json、jsonfm、none、php、phpfm、rawfm、xml、xmlfm

action=parse

main | parse

解析内容并返回解析器输出。

参见action=query的各种prop-module以从页面的当前版本获得信息。

这里有几种方法可以指定解析的文本:

  1. 指定一个页面或修订,使用pagepageidoldid
  2. 明确指定内容,使用texttitlerevidcontentmodel
  3. 只指定一段摘要解析。prop应提供一个空值。
参数:
title

文本属于的页面标题。如果省略,contentmodel就必须被指定,且API将作为标题使用。

text

要解析的文本。使用titlecontentmodel以控制内容模型。

revid

修订版本ID,用于{{REVISIONID}}和类似变体。

类型:整数
summary

要解析的摘要。

page

解析此页的内容。不能与texttitle一起使用。

pageid

解析此页的内容。覆盖page

类型:整数
redirects

如果pagepageid被设置为一个重定向,则解析它。

类型:布尔型 (详情)
oldid

解析该修订版本的内容。覆盖pagepageid

类型:整数
prop

要获取的信息束:

text
提供wikitext中的被解析文本。
langlinks
提供被解析的wikitext中的语言链接。
categories
提供被解析的wikitext中的分类。
categorieshtml
提供HTML版本分类。
links
提供被解析的wikitext中的内部链接。
templates
提供被解析的wikitext中的模板。
images
提供被解析的wikitext中的图片。
externallinks
提供被解析的wikitext中的外部链接。
sections
提供被解析的wikitext中的段落。
revid
添加被解析页面的修订ID。
displaytitle
为被解析的wikitext添加标题。
subtitle
为解析的页面添加页面副标题。
headhtml
给出页面的已解析的 doctype、开启的<html><head>元素和开启的<body>
modules
提供在页面中使用的ResourceLoader模块。要加载,请使用mw.loader.using()。无论jsconfigvars还是encodedjsconfigvars都必须与modules共同被请求。
jsconfigvars
针对页面提供JavaScript配置变量。要应用,请使用mw.config.set()
encodedjsconfigvars
针对页面提供JavaScript配置变量为一个JSON字符串。
indicators
提供页面上使用的页面状态指示器的HTML。
iwlinks
提供被解析的wikitext中的跨wiki链接。
wikitext
提供被解析的原始wikitext。
properties
提供多种定义在被解析的wikitext中的属性。
limitreportdata
以结构化的方式提供限制报告。如果disablelimitreport被设定则不提供数据。
limitreporthtml
提供限制报告的HTML版本。当disablelimitreport被设置时不会提供数据。
parsetree
修订内容的XML解析树(需要内容模型wikitext
parsewarnings
给出解析内容时发生的警告(作为wikitext)。
parsewarningshtml
给出解析内容时发生的警告(作为 HTML)。
headitems
已弃用。提供项目以插入至页面的<head>
值(以|替代物分隔):categories、categorieshtml、displaytitle、encodedjsconfigvars、externallinks、headhtml、images、indicators、iwlinks、jsconfigvars、langlinks、limitreportdata、limitreporthtml、links、modules、parsetree、parsewarnings、parsewarningshtml、properties、revid、sections、subtitle、templates、text、wikitext、headitems
默认:text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties|parsewarnings
wrapoutputclass

要用于包裹解析输出的CSS类。

默认:mw-parser-output
pst

在解析输入前,对输入做一次保存前变换处理。仅当使用文本时有效。

类型:布尔型 (详情)
onlypst

在输入内容中执行预保存转换(PST),但不解析它。在PST被应用后返回相同的wikitext。只当与text一起使用时有效。

类型:布尔型 (详情)
effectivelanglinks
已弃用。

包含由扩展提供的语言链接(用于与prop=langlinks一起使用)。

类型:布尔型 (详情)
section

只解析此段数的内容。

new时,将textsectiontitle解析为添加新段落至页面。

new段落只当指定text时允许。

sectiontitle

sectionnew时新段落标题。

不像页面编辑,当省略或为空时将不会备选为summary

disablepp
已弃用。

请改用disablelimitreport

类型:布尔型 (详情)
disablelimitreport

从解析器输出中省略限制报告(“NewPP limit report”)。

类型:布尔型 (详情)
disableeditsection

从解析器输出中省略编辑段落链接。

类型:布尔型 (详情)
disablestylededuplication

不要在解析器输出中删除重复的行内样式表。

类型:布尔型 (详情)
generatexml
已弃用。

生成XML解析树(需要内容模型wikitext;被prop=parsetree所取代)。

类型:布尔型 (详情)
preview

在预览模式下解析。

类型:布尔型 (详情)
sectionpreview

在段落预览模式下解析(同时要启用预览模式)。

类型:布尔型 (详情)
disabletoc

在输出中省略目录。

类型:布尔型 (详情)
useskin

为解析器输出应用选择的皮肤。会影响以下属性:langlinksheaditemsmodulesjsconfigvarsindicators

以下值中的一个:minerva、monobook、timeless、vector
contentformat

用于输入文本的内容序列化格式。只当与text一起使用时有效。

以下值中的一个:application/json、application/octet-stream、application/unknown、application/x-binary、text/css、text/javascript、text/plain、text/unknown、text/x-wiki、unknown/unknown
contentmodel

输入文本的内容模型。如果省略,title必须指定,并且默认将为指定标题的模型。只当与text一起使用时有效。

以下值中的一个:GadgetDefinition、Scribunto、css、javascript、json、smw/schema、text、unknown、wikitext
mobileformat

以适配移动设备的格式返回解析输出。

类型:布尔型 (详情)
mainpage

应用移动首页转换。

类型:布尔型 (详情)

action=patrol

main | patrol
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

巡查页面或修订版本。

参数:
rcid

要巡查的最近更改 ID。

类型:整数
revid

要巡查的修订版本ID。

类型:整数
tags

要在巡查日志中应用到实体的更改标签。

值(以|替代物分隔):
token

action=query&meta=tokens取回的“patrol”令牌

这个参数是必须的。

action=pfautocomplete

  • 此模块需要读取权限。
  • 来源:页面表单
  • 许可协议:GPL-2.0-or-later

由页面表单扩展所使用的自动完成。

参数:
limit

返回结果数量的限制

类型:整数或max
值必须介于1和500之间。
默认:10
substr

要自动完成的子字符串

property

值将自动完成的语义MediaWiki属性

category

页面将自动完成的分类

concept

页面将自动完成的语义MediaWiki“概念”

cargo_table

由Cargo扩展定义的,值将会自动完成的数据表

cargo_field

值将会自动完成的Cargo表格字段

namespace

页面将自动完成的命名空间

external_url

来自要获取值的外部URL的别名

baseprop

要检查的表单中早先的语义MediaWiki属性

base_cargo_table

要检查是否违反表单中前一字段的Cargo表格

base_cargo_field

要检查是否违反表单中前一字段的Cargo字段

basevalue

要检查之前属性或字段的值

action=pfautoedit

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 来源:页面表单
  • 许可协议:GPL-2.0-or-later

使用页面表单扩展定义的表单创建或编辑页面。

参数:
form

要使用的页面表单

target

要创建或编辑的页面名称

query

查询字符串

preload

要在表单中预加载的页面名称

action=pollsubmitvote

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:AJAX Poll
  • 许可协议:GFDL-1.2

AJAXPoll API模块

参数:
poll

调查ID,例如832A5FA2C2583A5732B90CEFF658FE25;ID由输入内容(问题+回答选项,也就是在<poll>...</poll>标签之间的文本)按MD5哈希算法格式化,并通过PHP的strtoupper函数转化结果为全大写

这个参数是必须的。
answer

数字回答选项标识符;使用0以撤回此前投出的票

这个参数是必须的。
类型:整数
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。
例子:
提交第三个(3)答案至ID为832A5FA2C2583A5732B90CEFF658FE25的调查
api.php?action=pollsubmitvote&poll=832A5FA2C2583A5732B90CEFF658FE25&answer=3 [在沙盒中打开]

action=protect

main | protect
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

更改页面的保护等级。

参数:
title

要(解除)保护的页面标题。不能与pageid一起使用。

pageid

要(解除)保护的页面ID。不能与title一起使用。

类型:整数
protections

保护等级列表,格式:action=level(例如edit=sysop)。等级all意味着任何人都可以执行操作,也就是说没有限制。

注意:未列出的操作将移除限制。

这个参数是必须的。
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
expiry

到期时间戳。如果只有一个时间戳被设置,它将被用于所有保护。使用infiniteindefiniteinfinitynever用于永不过期的保护。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
默认:infinite
reason

(解除)保护的原因。

默认:(空)
tags

要在保护日志中应用到实体的更改标签。

值(以|替代物分隔):
cascade

启用连锁保护(也就是保护包含于此页面的页面)。如果所有提供的保护等级不支持连锁,就将其忽略。

类型:布尔型 (详情)
watch
已弃用。

如果设置,就加入已开始(解除)保护的页面至当前用户的监视列表。

类型:布尔型 (详情)
watchlist

无条件地将页面加入至当前用户的监视列表或将其移除(忽略机器人用户),使用设置或不更改监视。

以下值中的一个:nochange、preferences、unwatch、watch
默认:preferences
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=purge

main | purge
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

为指定标题刷新缓存。

参数:
forcelinkupdate

更新链接表并执行其他次要数据更新。

类型:布尔型 (详情)
forcerecursivelinkupdate

forcelinkupdate相同,且更新任何使用此页面作为模板的页面的链接表。

类型:布尔型 (详情)
continue

当更多结果可用时,使用这个继续。

titles

要工作的标题列表。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
pageids

要工作的页面ID列表。

类型:整数列表
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
revids

要工作的修订ID列表。

类型:整数列表
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
generator

通过执行指定查询模块获得页面列表以工作。

注意:发生器参数名称必须以“g”开头,参见例子。

allcategories
列举所有分类。
alldeletedrevisions
列举由一位用户或在一个命名空间中所有已删除的修订。
allfileusages
列出所有文件用途,包括不存在的。
allimages
按顺序枚举所有图像。
alllinks
列举所有指向至指定命名空间的链接。
allpages
循序列举在指定命名空间中的所有页面。
allredirects
列出至一个命名空间的重定向。
allrevisions
列举所有修订。
alltransclusions
列出所有嵌入页面(使用{{x}}嵌入的页面),包括不存在的。
backlinks
查找所有链接至指定页面的页面。
categories
页面属于的所有分类列表。
categorymembers
在指定的分类中列出所有页面。
deletedrevisions
获取删除的修订版本信息。
duplicatefiles
根据哈希值列出此给定文件的所有副本。
embeddedin
查找所有嵌入指定标题的页面。
exturlusage
列举包含一个指定URL的页面。
fileusage
查找所有使用指定文件的页面。
images
返回指定页面上包含的所有文件。
imageusage
查找所有使用指定图片标题的页面。
iwbacklinks
查找所有链接至指定跨wiki链接的页面。
langbacklinks
查找所有链接至指定语言链接的页面。
links
从指定页面返回所有链接。
linkshere
查找所有链接至指定页面的页面。
pageswithprop
列出所有使用指定页面属性的页面。
prefixsearch
为页面标题执行前缀搜索。
protectedtitles
列出所有被限制创建的标题。
querypage
获取由基于QueryPage的特殊页面提供的列表。
random
获取随机页面集。
recentchanges
列举最近更改。
redirects
返回至指定页面的所有重定向。
revisions
获取修订版本信息。
search
执行一次全文本搜索。
templates
返回指定页面上所有被嵌入的页面。
transcludedin
查找所有嵌入指定页面的页面。
watchlist
在当前用户的监视列表中获取对页面的最近更改。
watchlistraw
获得当前用户的监视列表上的所有页面。
以下值中的一个:allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

自动解决在titlespageidsrevids,以及在由generator返回的页面中的重定向。

类型:布尔型 (详情)
converttitles

如有需要,将标题转换为其他变体。只有当wiki的内容语言支持变体转换时才能工作。支持变体转换的语言包括ban、en、crh、gan、iu、kk、ku、shi、sr、tg、uz和zh。

类型:布尔型 (详情)

action=query

main | query

取得来自并有关MediaWiki的数据。

所有数据修改须首先使用查询来获得令牌,以阻止来自恶意网站的滥用行为。

参数:
prop

要为已查询页面获取的属性。

categories
页面属于的所有分类列表。
categoryinfo
返回有关给定分类的信息。
cirrusbuilddoc
来自数据库服务器的CirrusSearch条目文档的转储
cirruscompsuggestbuilddoc
完成建议器使用的文档的转储
cirrusdoc
来自搜索服务器的CirrusSearch条目文档的转储
contributors
获取对一个页面的登录贡献者列表和匿名贡献数。
deletedrevisions
获取删除的修订版本信息。
duplicatefiles
根据哈希值列出此给定文件的所有副本。
extlinks
从指定页面返回所有外部URL(非跨wiki链接)。
fileusage
查找所有使用指定文件的页面。
imageinfo
返回文件信息和上传历史。
images
返回指定页面上包含的所有文件。
info
获取基本页面信息。
iwlinks
从指定页面返回所有跨wiki链接。
langlinks
从指定页面返回所有跨语言链接。
links
从指定页面返回所有链接。
linkshere
查找所有链接至指定页面的页面。
moderationpreload
If the current user made an edit which is currently awaiting moderation, retrieve the text of this revision.
pageprops
获取页面内容中定义的各种页面属性。
redirects
返回至指定页面的所有重定向。
revisions
获取修订版本信息。
stashimageinfo
返回用于藏匿文件的文件信息。
templates
返回指定页面上所有被嵌入的页面。
transcludedin
查找所有嵌入指定页面的页面。
值(以|替代物分隔):categoriescategoryinfocirrusbuilddoccirruscompsuggestbuilddoccirrusdoccontributorsdeletedrevisionsduplicatefilesextlinksfileusageimageinfoimagesinfoiwlinkslanglinkslinkslinksheremoderationpreloadpagepropsredirectsrevisionsstashimageinfotemplatestranscludedin
list

要获取的列表。

abusefilters
显示防滥用过滤器的详细说明。
abuselog
显示一个滥用过滤器的捕获事件。
allcategories
列举所有分类。
alldeletedrevisions
列举由一位用户或在一个命名空间中所有已删除的修订。
allfileusages
列出所有文件用途,包括不存在的。
allimages
按顺序枚举所有图像。
alllinks
列举所有指向至指定命名空间的链接。
allpages
循序列举在指定命名空间中的所有页面。
allredirects
列出至一个命名空间的重定向。
allrevisions
列举所有修订。
alltransclusions
列出所有嵌入页面(使用{{x}}嵌入的页面),包括不存在的。
allusers
列举所有注册用户。
backlinks
查找所有链接至指定页面的页面。
blocks
列出所有被封禁的用户和IP地址。
categorymembers
在指定的分类中列出所有页面。
embeddedin
查找所有嵌入指定标题的页面。
exturlusage
列举包含一个指定URL的页面。
filearchive
循序列举所有被删除的文件。
gadgetcategories
返回小工具分类列表。
gadgets
返回一个本Wiki上的小工具的列表。
imageusage
查找所有使用指定图片标题的页面。
iwbacklinks
查找所有链接至指定跨wiki链接的页面。
langbacklinks
查找所有链接至指定语言链接的页面。
logevents
从日志获取事件。
mystashedfiles
获取当前用户上传暂存库中的文件列表。
pagepropnames
列出wiki中所有使用中的页面属性名称。
pageswithprop
列出所有使用指定页面属性的页面。
prefixsearch
为页面标题执行前缀搜索。
protectedtitles
列出所有被限制创建的标题。
querypage
获取由基于QueryPage的特殊页面提供的列表。
random
获取随机页面集。
recentchanges
列举最近更改。
search
执行一次全文本搜索。
tags
列出更改标签。
usercontribs
获取一位用户的所有编辑。
users
获取有关列出用户的信息。
watchlist
在当前用户的监视列表中获取对页面的最近更改。
watchlistraw
获得当前用户的监视列表上的所有页面。
deletedrevs
已弃用。列举删除的修订版本。
值(以|替代物分隔):abusefiltersabuselogallcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsallusersbacklinksblockscategorymembersembeddedinexturlusagefilearchivegadgetcategoriesgadgetsimageusageiwbacklinkslangbacklinkslogeventsmystashedfilespagepropnamespageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangessearchtagsusercontribsuserswatchlistwatchlistrawdeletedrevs
meta

要获取的元数据。

allmessages
返回来自该网站的消息。
authmanagerinfo
检索有关当前身份验证状态的信息。
filerepoinfo
返回有关wiki配置的图片存储库的元信息。
languageinfo
返回有关可用语言的信息。
notifications
获取当前用户等待的通知。
siteinfo
返回有关网站的一般信息。
tokens
获取可修改数据的操作的令牌。
unreadnotificationpages
获取当前用户未读通知的相关页面。
userinfo
获取有关当前用户的信息。
值(以|替代物分隔):allmessagesauthmanagerinfofilerepoinfolanguageinfonotificationssiteinfotokensunreadnotificationpagesuserinfo
indexpageids

包含一个额外的pageid段落,列举所有返回的页面ID。

类型:布尔型 (详情)
export

导出所有指定或生成页面的当前修订。

类型:布尔型 (详情)
exportnowrap

返回导出XML,不需要将其包裹在一个XML结果中(与Special:Export格式相同)。只能与query+export一起使用。

类型:布尔型 (详情)
exportschema

选择导出 XML 转储文件时的特定版本。仅能与query+export一起使用。

以下值中的一个:0.10、0.11
默认:0.11
iwurl

如果标题是一个跨wiki链接的话,是否获取完整URL。

类型:布尔型 (详情)
continue

当更多结果可用时,使用这个继续。

rawcontinue

为继续返回原始query-continue数据。

类型:布尔型 (详情)
titles

要工作的标题列表。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
pageids

要工作的页面ID列表。

类型:整数列表
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
revids

要工作的修订ID列表。

类型:整数列表
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
generator

通过执行指定查询模块获得页面列表以工作。

注意:发生器参数名称必须以“g”开头,参见例子。

allcategories
列举所有分类。
alldeletedrevisions
列举由一位用户或在一个命名空间中所有已删除的修订。
allfileusages
列出所有文件用途,包括不存在的。
allimages
按顺序枚举所有图像。
alllinks
列举所有指向至指定命名空间的链接。
allpages
循序列举在指定命名空间中的所有页面。
allredirects
列出至一个命名空间的重定向。
allrevisions
列举所有修订。
alltransclusions
列出所有嵌入页面(使用{{x}}嵌入的页面),包括不存在的。
backlinks
查找所有链接至指定页面的页面。
categories
页面属于的所有分类列表。
categorymembers
在指定的分类中列出所有页面。
deletedrevisions
获取删除的修订版本信息。
duplicatefiles
根据哈希值列出此给定文件的所有副本。
embeddedin
查找所有嵌入指定标题的页面。
exturlusage
列举包含一个指定URL的页面。
fileusage
查找所有使用指定文件的页面。
images
返回指定页面上包含的所有文件。
imageusage
查找所有使用指定图片标题的页面。
iwbacklinks
查找所有链接至指定跨wiki链接的页面。
langbacklinks
查找所有链接至指定语言链接的页面。
links
从指定页面返回所有链接。
linkshere
查找所有链接至指定页面的页面。
pageswithprop
列出所有使用指定页面属性的页面。
prefixsearch
为页面标题执行前缀搜索。
protectedtitles
列出所有被限制创建的标题。
querypage
获取由基于QueryPage的特殊页面提供的列表。
random
获取随机页面集。
recentchanges
列举最近更改。
redirects
返回至指定页面的所有重定向。
revisions
获取修订版本信息。
search
执行一次全文本搜索。
templates
返回指定页面上所有被嵌入的页面。
transcludedin
查找所有嵌入指定页面的页面。
watchlist
在当前用户的监视列表中获取对页面的最近更改。
watchlistraw
获得当前用户的监视列表上的所有页面。
以下值中的一个:allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

自动解决在query+titlesquery+pageidsquery+revids,以及在由query+generator返回的页面中的重定向。

类型:布尔型 (详情)
converttitles

如有需要,将标题转换为其他变体。只有当wiki的内容语言支持变体转换时才能工作。支持变体转换的语言包括ban、en、crh、gan、iu、kk、ku、shi、sr、tg、uz和zh。

类型:布尔型 (详情)

prop=categories (cl)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

页面属于的所有分类列表。

参数:
clprop

要为每个分类获取的额外属性:

sortkey
为每个分类添加关键词(十六进制字符串)和关键词前缀(人类可读部分)。
timestamp
添加分类添加时的时间戳。
hidden
标记由__HIDDENCAT__隐藏的分类。
值(以|替代物分隔):hidden、sortkey、timestamp
clshow

显示何种分类。

值(以|替代物分隔):!hidden、hidden
cllimit

返回多少分类。

类型:整数或max
值必须介于1和500之间。
默认:10
clcontinue

当更多结果可用时,使用这个继续。

clcategories

只列出这些分类。对于检查某一页面使用某一分类很有用。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
cldir

罗列所采用的方向。

以下值中的一个:ascending、descending
默认:ascending

prop=categoryinfo (ci)

返回有关给定分类的信息。

参数:
cicontinue

当更多结果可用时,使用这个继续。

例子:
获取有关Category:FooCategory:Bar的信息。
api.php?action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar [在沙盒中打开]

prop=cirrusbuilddoc (cb)

  • 此模块需要读取权限。
  • 来源:CirrusSearch
  • 许可协议:GPL-2.0-or-later

来自数据库服务器的CirrusSearch条目文档的转储

例子:
获取生成自数据库的单个CirrusSearch条目的转储。
api.php?action=query&prop=cirrusbuilddoc&titles=Main_Page [在沙盒中打开]

prop=cirruscompsuggestbuilddoc (csb)

  • 此模块需要读取权限。
  • 来源:CirrusSearch
  • 许可协议:GPL-2.0-or-later

完成建议器使用的文档的转储

参数:
csbmethod

使用的评分方法

默认:quality

prop=cirrusdoc (cd)

main | query | cirrusdoc
  • 此模块需要读取权限。
  • 来源:CirrusSearch
  • 许可协议:GPL-2.0-or-later

来自搜索服务器的CirrusSearch条目文档的转储

例子:
获取当前索引进搜索的单个CirrusSearch条目的转储。
api.php?action=query&prop=cirrusdoc&titles=Main_Page [在沙盒中打开]

prop=contributors (cn)

  • 此模块需要读取权限。
  • 来源:Contributors
  • 许可协议:GPL-2.0-or-later

获取对一个页面的登录贡献者列表和匿名贡献数。

参数:
cntitles
⧼apihelp-query+contributors-param-titles⧽
这个参数是必须的。

prop=deletedrevisions (drv)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

获取删除的修订版本信息。

可在很多途径中使用:

  1. 获得一组页面的已删除修订,通过设置标题或页面ID。以标题和时间戳排序。
  2. 通过设置它们的ID与修订ID获得关于一组已删除修订。以修订ID排序。
参数:
drvprop

要为每个修订获取的属性:

ids
修订版本的ID。
flags
修订标记(小编辑)。
timestamp
修订的时间戳。
user
进行修订的用户。如果用户已被版本删除,将返回userhidden属性。
userid
修订创建者的用户ID。如果用户已被版本删除,将返回userhidden属性。
size
修订的长度(字节)。
slotsize
每次修订间隔的长度(字节)。
sha1
修订版的SHA-1(base 16)。如果内容已被版本删除,将返回sha1hidden属性。
slotsha1
每次修订间隔的SHA-1(base 16)。如果内容已被版本删除,将返回sha1hidden属性。
contentmodel
每次修订间隔的内容模型ID。
comment
用户对修订的评论。如果评论已被版本删除,将返回commenthidden属性。
parsedcomment
用户对修订的解析注释。如果评论已被版本删除,将返回commenthidden属性。
content
每次修订间隔的内容。如果内容已被版本删除,将返回texthidden属性。
tags
修订标签。
roles
List content slot roles that exist in the revision.
parsetree
已弃用。请改用action=expandtemplatesaction=parse。修订内容的XML解析树(需要内容模型wikitext)。
值(以|替代物分隔):comment、content、contentmodel、flags、ids、parsedcomment、roles、sha1、size、slotsha1、slotsize、tags、timestamp、user、userid、parsetree
默认:ids|timestamp|flags|comment|user
drvslots

Which revision slots to return data for, when slot-related properties are included in drvprops. If omitted, data from the main slot will be returned in a backwards-compatible format.

值(以|替代物分隔):main
要指定所有值,请使用*
drvlimit

限制返回多少修订。

类型:整数或max
值必须介于1和500之间。
drvexpandtemplates
已弃用。

请改用action=expandtemplates。展开修订内容中的模板(需要drvprop=content)。

类型:布尔型 (详情)
drvgeneratexml
已弃用。

请改用action=expandtemplatesaction=parse。生成用于修订内容的XML解析树(需要drvprop=content;被drvprop=parsetree所取代)。

类型:布尔型 (详情)
drvparse
已弃用。

请改用action=parse。解析修订内容(需要drvprop=content)。由于性能原因,如果此选项被使用,drvlimit会被强制为1。

类型:布尔型 (详情)
drvsection

只检索此段落数的内容。

drvdiffto
已弃用。

请改用action=compare。要比较修订差异的修订ID。使用prevnextcur分别用于上个、下个和当前修订。

drvdifftotext
已弃用。

请改用action=compare。要比较修订差异的文本。只有修订的有限数字内的差异。覆盖drvdiffto。如果drvsection被设置,只有那个段落将与此文本之间比较差异

drvdifftotextpst
已弃用。

请改用action=compare。在编辑文本前对其执行预保存转换。只当与drvdifftotext一起使用时有效。

类型:布尔型 (详情)
drvcontentformat
已弃用。

序列化用于drvdifftotext的格式并预估内容输出。

以下值中的一个:application/json、application/octet-stream、application/unknown、application/x-binary、text/css、text/javascript、text/plain、text/unknown、text/x-wiki、unknown/unknown
drvstart

要开始枚举的时间戳。当处理修订ID列表时会被忽略。

类型:时间戳(允许格式
drvend

要停止枚举的时间戳。当处理修订ID列表时会被忽略。

类型:时间戳(允许格式
drvdir

列举的方向:

newer
最早的优先。注意:drvstart应早于drvend。
older
最新的优先(默认)。注意:drvstart应晚于drvend。
以下值中的一个:newer、older
默认:older
drvtag

只列出被此标签标记的修订。

drvuser

只列出此用户做出的修订。

类型:通过 用户名、IP、跨wiki用户名(例如“前缀>示例用户”)和用户ID(例如“#12345”) 中任意一种方式指定的用户
drvexcludeuser

不要列出此用户做出的修订。

类型:通过 用户名、IP、跨wiki用户名(例如“前缀>示例用户”)和用户ID(例如“#12345”) 中任意一种方式指定的用户
drvcontinue

当更多结果可用时,使用这个继续。

prop=duplicatefiles (df)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

根据哈希值列出此给定文件的所有副本。

参数:
dflimit

返回多少重复文件。

类型:整数或max
值必须介于1和500之间。
默认:10
dfcontinue

当更多结果可用时,使用这个继续。

dfdir

罗列所采用的方向。

以下值中的一个:ascending、descending
默认:ascending
dflocalonly

只看本地存储库的文件。

类型:布尔型 (详情)
main | query | extlinks

从指定页面返回所有外部URL(非跨wiki链接)。

参数:
ellimit

返回多少链接。

类型:整数或max
值必须介于1和500之间。
默认:10
elcontinue

当更多结果可用时,使用这个继续。

elprotocol

URL协议。如果为空并且elquery被设置,协议为http。将此和elquery都留空以列举所有外部链接。

以下值中的一个:可以为空,或bitcoin、ftp、ftps、geo、git、gopher、http、https、irc、ircs、magnet、mailto、mms、news、nntp、redis、sftp、sip、sips、sms、ssh、svn、tel、telnet、urn、worldwind、xmpp
默认:(空)
elquery

不使用协议搜索字符串。对于检查某一页面是否包含某一外部URL很有用。

elexpandurl

扩展协议相对URL与规范协议。

类型:布尔型 (详情)
例子:
获取Main Page的外部链接列表。
api.php?action=query&prop=extlinks&titles=Main%20Page [在沙盒中打开]

prop=fileusage (fu)

main | query | fileusage
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

查找所有使用指定文件的页面。

参数:
fuprop

要获取的属性:

pageid
每个页面的页面ID。
title
每个页面的标题。
redirect
标记作为重定向的页面。
值(以|替代物分隔):pageid、redirect、title
默认:pageid|title|redirect
funamespace

只包括这些命名空间的页面。

值(以|替代物分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
要指定所有值,请使用*
fushow

只显示符合以下标准的项:

redirect
只显示重定向。
!redirect
只显示非重定向。
值(以|替代物分隔):!redirect、redirect
fulimit

返回多少。

类型:整数或max
值必须介于1和500之间。
默认:10
fucontinue

当更多结果可用时,使用这个继续。

prop=imageinfo (ii)

main | query | imageinfo

返回文件信息和上传历史。

参数:
iiprop

要获取的文件信息:

timestamp
添加时间戳至上传的版本。
user
添加上传了各个文件版本的用户。若该用户已被删除修订,将返回userhidden属性。
userid
添加上传了各个文件版本的用户的 ID。若该用户已被删除修订,将返回userhidden属性。
comment
此版本的摘要。若该用户已被删除修订,将返回userhidden属性。
parsedcomment
解析版本上的注释。若该注释已被删除修订,将返回commenthidden属性。
canonicaltitle
添加文件的规范标题。若该文件已被删除修订,将返回filehidden属性。
url
为文件及其描述页面提供 URL。若该文件已被删除修订,将返回filehidden属性。
size
添加文件大小(字节)及其高度、宽度和页面数(如果可以)。
dimensions
用于大小的别名。
sha1
为文件加入 SHA-1 哈希值。若该文件已被删除修订,将返回filehidden属性。
mime
添加文件的 MIME 类型。若该文件已被删除修订,将返回filehidden属性。
thumbmime
添加图片缩略图的 MIME 类型(需要 url 和参数 iiurlwidth)。若该文件已被删除修订,将返回filehidden属性。
mediatype
添加文件媒体类型。若该文件已被删除修订,将返回filehidden属性。
metadata
列出这个版本的文件的 EXIF 元数据。若该文件已被删除修订,将返回filehidden属性。
commonmetadata
为文件的修订版本列出文件格式通用元数据。若该文件已被删除修订,将返回filehidden属性。
extmetadata
列出结合自多个来源的格式化的元数据。结果均依HTML格式化。如果文件已被修订删除,filehidden 属性会被退回。
archivename
添加用于非最新修订的存档修订的文件名。如果文件已被修订删除,filehidden 属性会被退回。
bitdepth
添加修订的字节深度。若该文件已被删除修订,将返回 filehidden 属性。
uploadwarning
由Special:Upload所使用,以获取关于现有文件的信息。不适用于MediaWiki核心以外代码。
badfile
无论文件是否在MediaWiki:Bad image list都添加
值(以|替代物分隔):archivename、badfile、bitdepth、canonicaltitle、comment、commonmetadata、dimensions、extmetadata、mediatype、metadata、mime、parsedcomment、sha1、size、thumbmime、timestamp、uploadwarning、url、user、userid
默认:timestamp|user
iilimit

每个文件返回多少文件修订。

类型:整数或max
值必须介于1和500之间。
默认:1
iistart

开始列举的时间戳。

类型:时间戳(允许格式
iiend

列举的结束时间戳。

类型:时间戳(允许格式
iiurlwidth

如果iiprop=url被设定,将返回至缩放到此宽度的一张图片的URL。 由于性能原因,如果此消息被使用,将不会返回超过50张被缩放的图片。

类型:整数
默认:-1
iiurlheight

与iiurlwidth类似。

类型:整数
默认:-1
iimetadataversion

要使用的元数据版本。如果latest被指定,则使用最新版本。默认为1以便向下兼容。

默认:1
iiextmetadatalanguage

要取得extmetadata的语言。这会影响到抓取翻译的选择,如果有多个可用的话,还会影响到数字等数值的格式。

默认:zh-cn
iiextmetadatamultilang

如果用于extmetadata属性的翻译可用,则全部取得。

类型:布尔型 (详情)
iiextmetadatafilter

如果指定且非空,则只为iiprop=extmetadata返回这些键。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
iiurlparam

处理器特定的参数字符串。例如PDF可能使用page15-100pxiiurlwidth必须被使用,并与iiurlparam一致。

默认:(空)
iibadfilecontexttitle

如果badfilecontexttitleprop=badfile被设置,这会是在评估MediaWiki:Bad image list时使用的页面标题

iicontinue

当更多结果可用时,使用这个继续。

iilocalonly

只看本地存储库的文件。

类型:布尔型 (详情)

prop=images (im)

main | query | images
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

返回指定页面上包含的所有文件。

参数:
imlimit

返回多少文件。

类型:整数或max
值必须介于1和500之间。
默认:10
imcontinue

当更多结果可用时,使用这个继续。

imimages

只列出这些文件。对于检查某一页面是否使用某一文件很有用。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
imdir

罗列所采用的方向。

以下值中的一个:ascending、descending
默认:ascending

prop=info (in)

main | query | info

获取基本页面信息。

参数:
inprop

要获取的额外属性:

protection
列出每个页面的保护等级。
talkid
每个非讨论页面的讨论页的页面ID。
watched
列出每个页面的被监视状态。
watchers
监视人员数,如果允许。
visitingwatchers
访问了每个页面的最近编辑的监视者数量,如果允许。
notificationtimestamp
每个页面的监视列表通知时间戳。
subjectid
每个讨论页的母页面的页面ID。
associatedpage
The prefixed title of the associated subject or talk page.
url
为每个页面提供一个完整URL、一个编辑URL和规范URL。
readable
已弃用。用户是否可以阅读此页面。使用 intestactions=read 替代。
preload
提供由EditFormPreloadText返回的文本。
displaytitle
在页面标题实际显示的地方提供方式。
varianttitles
提供网站内容语言所有变体的显示标题。
linkclasses
如果链接出现在由inlinkcontext命名的页面上,则提供用于链接到此页面的其他CSS 类(例如链接颜色)。
值(以|替代物分隔):associatedpage、displaytitle、linkclasses、notificationtimestamp、preload、protection、subjectid、talkid、url、varianttitles、visitingwatchers、watched、watchers、readable
inlinkcontext

inprop包含linkclasses时,在确定额外CSS类(例如链接颜色)时使用的上下文标题。

类型:页面标题
接受不存在的页面。
默认:首页
intestactions

测试当前用户是否可以在页面上执行某种操作。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
intestactionsdetail

intestactions的详细级别。使用主模块errorformaterrorlang参数来控制返回消息的格式。

boolean
为每个操作返回一个布尔值。
full
返回描述操作被禁止的原因的消息,如果允许则返回一个空数组。
quick
类似于填充但是跳过需要花费大量资源的检查
以下值中的一个:boolean、full、quick
默认:boolean
incontinue

当更多结果可用时,使用这个继续。

main | query | iwlinks

从指定页面返回所有跨wiki链接。

参数:
iwprop

为每个跨wiki链接获取的额外属性:

url
添加完整URL。
值(以|替代物分隔):url
iwprefix

只返回此前缀的跨wiki链接。

iwtitle

用于搜索的跨wiki链接。必须与iwprefix一起使用。

iwdir

罗列所采用的方向。

以下值中的一个:ascending、descending
默认:ascending
iwlimit

返回多少跨wiki链接。

类型:整数或max
值必须介于1和500之间。
默认:10
iwcontinue

当更多结果可用时,使用这个继续。

iwurl
已弃用。

是否获取完整URL(不能与iwprop一起使用)。

类型:布尔型 (详情)
例子:
从页面Main Page获得跨wiki链接。
api.php?action=query&prop=iwlinks&titles=Main%20Page [在沙盒中打开]
main | query | langlinks

从指定页面返回所有跨语言链接。

参数:
llprop

要为每个跨语言链接获取的额外属性:

url
添加完整URL。
langname
添加本地化语言名(尽可能)。使用llinlanguagecode以控制语言。
autonym
添加本地语言名。
值(以|替代物分隔):autonym、langname、url
lllang

只返回带此语言代码的语言链接。

lltitle

要搜索的链接。必须与lllang一起使用。

lldir

罗列所采用的方向。

以下值中的一个:ascending、descending
默认:ascending
llinlanguagecode

本地化语言名称的语言代码。

默认:zh-cn
lllimit

返回多少语言链接。

类型:整数或max
值必须介于1和500之间。
默认:10
llcontinue

当更多结果可用时,使用这个继续。

llurl
已弃用。

是否获取完整URL(不能与llprop一起使用)。

类型:布尔型 (详情)
main | query | links
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

从指定页面返回所有链接。

参数:
plnamespace

只显示这些命名空间的链接。

值(以|替代物分隔):-1、-2、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
要指定所有值,请使用*
pllimit

返回多少链接。

类型:整数或max
值必须介于1和500之间。
默认:10
plcontinue

当更多结果可用时,使用这个继续。

pltitles

只列出这些标题。对于检查某一页面是否使用某一标题很有用。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
pldir

罗列所采用的方向。

以下值中的一个:ascending、descending
默认:ascending
例子:
从页面Main Page获取链接。
api.php?action=query&prop=links&titles=Main%20Page [在沙盒中打开]
获取有关在页面Main Page中连接的页面的信息。
api.php?action=query&generator=links&titles=Main%20Page&prop=info [在沙盒中打开]
获取在用户和模板命名空间中来自页面Main Page的链接。
api.php?action=query&prop=links&titles=Main%20Page&plnamespace=2|10 [在沙盒中打开]

prop=linkshere (lh)

main | query | linkshere
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

查找所有链接至指定页面的页面。

参数:
lhprop

要获取的属性:

pageid
每个页面的页面ID。
title
每个页面的标题。
redirect
如果页面是一个重定向就标记。
值(以|替代物分隔):pageid、redirect、title
默认:pageid|title|redirect
lhnamespace

只包括这些命名空间的页面。

值(以|替代物分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
要指定所有值,请使用*
lhshow

只显示符合以下标准的项:

redirect
只显示重定向。
!redirect
只显示非重定向。
值(以|替代物分隔):!redirect、redirect
lhlimit

返回多少。

类型:整数或max
值必须介于1和500之间。
默认:10
lhcontinue

当更多结果可用时,使用这个继续。

prop=moderationpreload (mp)

  • 此模块需要读取权限。
  • 来源:Moderation
  • 许可协议:GPL-3.0+

If the current user made an edit which is currently awaiting moderation, retrieve the text of this revision.

参数:
mpmode

Expected format, either wikitext or parsed HTML.

以下值中的一个:parsed、wikitext
默认:wikitext
mptitle

Title of the page. Cannot be used together with mppageid.

mppageid

Page ID of the page. Cannot be used together with mptitle.

类型:整数
mpsection

Only retrieve the content of this section number.

例子:
Get wikitext of the pending edit by this user in the page Cat.
api.php?action=query&prop=moderationpreload&mptitle=Cat [在沙盒中打开]
Get HTML of the pending edit by this user in the page Dog.
api.php?action=query&prop=moderationpreload&mptitle=Dog&mpmode=parsed [在沙盒中打开]
Get wikitext of section #2 (third section) of the pending edit by this user in the page Cat.
api.php?action=query&prop=moderationpreload&mptitle=Cat&mpsection=2 [在沙盒中打开]

prop=pageprops (pp)

main | query | pageprops

获取页面内容中定义的各种页面属性。

参数:
ppcontinue

当更多结果可用时,使用这个继续。

ppprop

只列出这些页面属性(action=query&list=pagepropnames返回使用中的页面属性名称)。在检查页面是否使用某一页面属性时有用。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
例子:
获取用于页面Main PageMediaWiki的属性。
api.php?action=query&prop=pageprops&titles=Main%20Page|MediaWiki [在沙盒中打开]

prop=redirects (rd)

main | query | redirects
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

返回至指定页面的所有重定向。

参数:
rdprop

要获取的属性:

pageid
每个重定向的页面ID。
title
每个重定向的标题。
fragment
每个重定向的碎片,如果有。
值(以|替代物分隔):fragment、pageid、title
默认:pageid|title
rdnamespace

只包含这些命名空间的页面。

值(以|替代物分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
要指定所有值,请使用*
rdshow

只显示符合这些标准的项目:

fragment
只显示带碎片的重定向。
!fragment
只显示不带碎片的重定向。
值(以|替代物分隔):!fragment、fragment
rdlimit

返回多少重定向。

类型:整数或max
值必须介于1和500之间。
默认:10
rdcontinue

当更多结果可用时,使用这个继续。

prop=revisions (rv)

main | query | revisions
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

获取修订版本信息。

可用于以下几个方面:

  1. 通过设置标题或页面ID获取一批页面(最新修订)的数据。
  2. 通过使用带start、end或limit的标题或页面ID获取给定页面的多个修订。
  3. 通过revid设置一批修订的ID获取它们的数据。
参数:
rvprop

要为每个修订获取的属性:

ids
修订版本的ID。
flags
修订标记(小编辑)。
timestamp
修订的时间戳。
user
进行修订的用户。如果用户已被版本删除,将返回userhidden属性。
userid
修订创建者的用户ID。如果用户已被版本删除,将返回userhidden属性。
size
修订的长度(字节)。
slotsize
每次修订间隔的长度(字节)。
sha1
修订版的SHA-1(base 16)。如果内容已被版本删除,将返回sha1hidden属性。
slotsha1
每次修订间隔的SHA-1(base 16)。如果内容已被版本删除,将返回sha1hidden属性。
contentmodel
每次修订间隔的内容模型ID。
comment
用户对修订的评论。如果评论已被版本删除,将返回commenthidden属性。
parsedcomment
用户对修订的解析注释。如果评论已被版本删除,将返回commenthidden属性。
content
每次修订间隔的内容。如果内容已被版本删除,将返回texthidden属性。
tags
修订标签。
roles
List content slot roles that exist in the revision.
parsetree
已弃用。请改用action=expandtemplatesaction=parse。修订内容的XML解析树(需要内容模型wikitext)。
值(以|替代物分隔):comment、content、contentmodel、flags、ids、parsedcomment、roles、sha1、size、slotsha1、slotsize、tags、timestamp、user、userid、parsetree
默认:ids|timestamp|flags|comment|user
rvslots

Which revision slots to return data for, when slot-related properties are included in rvprops. If omitted, data from the main slot will be returned in a backwards-compatible format.

值(以|替代物分隔):main
要指定所有值,请使用*
rvlimit

限制返回多少修订。

只能在单一页面模式中使用(模式#2)。
类型:整数或max
值必须介于1和500之间。
rvexpandtemplates
已弃用。

请改用action=expandtemplates。展开修订内容中的模板(需要rvprop=content)。

类型:布尔型 (详情)
rvgeneratexml
已弃用。

请改用action=expandtemplatesaction=parse。生成用于修订内容的XML解析树(需要rvprop=content;被rvprop=parsetree所取代)。

类型:布尔型 (详情)
rvparse
已弃用。

请改用action=parse。解析修订内容(需要rvprop=content)。由于性能原因,如果此选项被使用,rvlimit会被强制为1。

类型:布尔型 (详情)
rvsection

只检索此段落数的内容。

rvdiffto
已弃用。

请改用action=compare。要比较修订差异的修订ID。使用prevnextcur分别用于上个、下个和当前修订。

rvdifftotext
已弃用。

请改用action=compare。要比较修订差异的文本。只有修订的有限数字内的差异。覆盖rvdiffto。如果rvsection被设置,只有那个段落将与此文本之间比较差异

rvdifftotextpst
已弃用。

请改用action=compare。在编辑文本前对其执行预保存转换。只当与rvdifftotext一起使用时有效。

类型:布尔型 (详情)
rvcontentformat
已弃用。

序列化用于rvdifftotext的格式并预估内容输出。

以下值中的一个:application/json、application/octet-stream、application/unknown、application/x-binary、text/css、text/javascript、text/plain、text/unknown、text/x-wiki、unknown/unknown
rvstartid

从这个修订版本时间戳开始列举。修订版本必须存在,但未必与该页面相关。

只能在单一页面模式中使用(模式#2)。
类型:整数
rvendid

在这个修订版本时间戳停止列举。修订版本必须存在,但未必与该页面相关。

只能在单一页面模式中使用(模式#2)。
类型:整数
rvstart

从哪个修订版本时间戳开始列举。

只能在单一页面模式中使用(模式#2)。
类型:时间戳(允许格式
rvend

列举直至此时间戳。

只能在单一页面模式中使用(模式#2)。
类型:时间戳(允许格式
rvdir

列举的方向:

newer
最早的优先。注意:rvstart应早于rvend。
older
最新的优先(默认)。注意:rvstart应晚于rvend。
只能在单一页面模式中使用(模式#2)。
以下值中的一个:newer、older
默认:older
rvuser

只包含由用户做出的修订。

只能在单一页面模式中使用(模式#2)。
类型:通过 用户名、IP、跨wiki用户名(例如“前缀>示例用户”)和用户ID(例如“#12345”) 中任意一种方式指定的用户
rvexcludeuser

不包括由用户做出的修订。

只能在单一页面模式中使用(模式#2)。
类型:通过 用户名、IP、跨wiki用户名(例如“前缀>示例用户”)和用户ID(例如“#12345”) 中任意一种方式指定的用户
rvtag

只列出被此标签标记的修订。

rvcontinue

当更多结果可用时,使用这个继续。

prop=stashimageinfo (sii)

返回用于藏匿文件的文件信息。

参数:
siifilekey

用于识别一次临时藏匿的早前上传的关键字。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
siisessionkey
已弃用。

siifilekey的别名,用于向后兼容。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
siiprop

要获取的文件信息:

timestamp
添加时间戳至上传的版本。
canonicaltitle
添加文件的规范标题。若该文件已被删除修订,将返回filehidden属性。
url
为文件及其描述页面提供 URL。若该文件已被删除修订,将返回filehidden属性。
size
添加文件大小(字节)及其高度、宽度和页面数(如果可以)。
dimensions
用于大小的别名。
sha1
为文件加入 SHA-1 哈希值。若该文件已被删除修订,将返回filehidden属性。
mime
添加文件的 MIME 类型。若该文件已被删除修订,将返回filehidden属性。
thumbmime
添加图片缩略图的 MIME 类型(需要 url 和参数 siiurlwidth)。若该文件已被删除修订,将返回filehidden属性。
metadata
列出这个版本的文件的 EXIF 元数据。若该文件已被删除修订,将返回filehidden属性。
commonmetadata
为文件的修订版本列出文件格式通用元数据。若该文件已被删除修订,将返回filehidden属性。
extmetadata
列出结合自多个来源的格式化的元数据。结果均依HTML格式化。如果文件已被修订删除,filehidden 属性会被退回。
bitdepth
添加修订的字节深度。若该文件已被删除修订,将返回 filehidden 属性。
badfile
无论文件是否在MediaWiki:Bad image list都添加
值(以|替代物分隔):badfile、bitdepth、canonicaltitle、commonmetadata、dimensions、extmetadata、metadata、mime、sha1、size、thumbmime、timestamp、url
默认:timestamp|url
siiurlwidth

如果siiprop=url被设定,将返回至缩放到此宽度的一张图片的URL。 由于性能原因,如果此消息被使用,将不会返回超过50张被缩放的图片。

类型:整数
默认:-1
siiurlheight

与siiurlwidth类似。

类型:整数
默认:-1
siiurlparam

处理器特定的参数字符串。例如PDF可能使用page15-100pxsiiurlwidth必须被使用,并与siiurlparam一致。

默认:(空)

prop=templates (tl)

main | query | templates
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

返回指定页面上所有被嵌入的页面。

参数:
tlnamespace

只显示此命名空间的模板。

值(以|替代物分隔):-1、-2、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
要指定所有值,请使用*
tllimit

返回的模板数量。

类型:整数或max
值必须介于1和500之间。
默认:10
tlcontinue

当更多结果可用时,使用这个继续。

tltemplates

只列出这些模板。对于检查某一页面使用某一模板很有用。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
tldir

罗列所采用的方向。

以下值中的一个:ascending、descending
默认:ascending
例子:
获取在页面Main Page使用的模板。
api.php?action=query&prop=templates&titles=Main%20Page [在沙盒中打开]
获取有关Main Page中使用的模板页面的信息。
api.php?action=query&generator=templates&titles=Main%20Page&prop=info [在沙盒中打开]
获取在用户和模板命名空间中,嵌入在Main Page页面的页面。
api.php?action=query&prop=templates&titles=Main%20Page&tlnamespace=2|10 [在沙盒中打开]

prop=transcludedin (ti)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

查找所有嵌入指定页面的页面。

参数:
tiprop

要获取的属性:

pageid
每个页面的页面ID。
title
每个页面的标题。
redirect
标记作为重定向的页面。
值(以|替代物分隔):pageid、redirect、title
默认:pageid|title|redirect
tinamespace

至包含这些命名空间的页面。

值(以|替代物分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
要指定所有值,请使用*
tishow

只显示符合以下标准的项:

redirect
只显示重定向。
!redirect
只显示非重定向。
值(以|替代物分隔):!redirect、redirect
tilimit

返回多少。

类型:整数或max
值必须介于1和500之间。
默认:10
ticontinue

当更多结果可用时,使用这个继续。

list=abusefilters (abf)

  • 此模块需要读取权限。
  • 来源:Abuse Filter
  • 许可协议:GPL-2.0-or-later

显示防滥用过滤器的详细说明。

参数:
abfstartid

枚举的起始过滤器ID。

类型:整数
abfendid

枚举的结束过滤器ID。

类型:整数
abfdir

列举的方向:

newer
最早的优先。注意:abfstart应早于abfend。
older
最新的优先(默认)。注意:abfstart应晚于abfend。
以下值中的一个:newer、older
默认:newer
abfshow

只显示符合这些标准的过滤器。

值(以|替代物分隔):!deleted、!enabled、!private、deleted、enabled、private
abflimit

过滤器列表的最大数量。

类型:整数或max
值必须介于1和500之间。
默认:10
abfprop

要获取的属性。

值(以|替代物分隔):actions、comments、description、hits、id、lasteditor、lastedittime、pattern、private、status
默认:id|description|actions|status

list=abuselog (afl)

main | query | abuselog
  • 此模块需要读取权限。
  • 来源:Abuse Filter
  • 许可协议:GPL-2.0-or-later

显示一个滥用过滤器的捕获事件。

参数:
afllogid

显示指定日志ID的记录。

类型:整数
aflstart

枚举的起始时间戳。

类型:时间戳(允许格式
aflend

枚举的结束时间戳。

类型:时间戳(允许格式
afldir

列举的方向:

newer
最早的优先。注意:aflstart应早于aflend。
older
最新的优先(默认)。注意:aflstart应晚于aflend。
以下值中的一个:newer、older
默认:older
afluser

只显示由指定的用户或IP地址完成的记录。

afltitle

只显示在指定页面上发生过的条项。

aflfilter

只显示被指定过滤器ID捕获过的记录。使用管道字符分离,以“global-”开始以表示为公共过滤器。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
afllimit

列出日志记录的最大数量。

类型:整数或max
值必须介于1和500之间。
默认:10
aflprop

要获得的属性。

值(以|替代物分隔):action、details、filter、hidden、ids、result、revid、timestamp、title、user
默认:ids|user|title|action|result|timestamp|hidden|revid

list=allcategories (ac)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

列举所有分类。

参数:
acfrom

要作为枚举起始点的类别。

accontinue

当更多结果可用时,使用这个继续。

acto

要作为枚举终止点的类别。

acprefix

搜索所有以此值开头的分类标题。

acdir

排序方向。

以下值中的一个:ascending、descending
默认:ascending
acmin

只返回至少带这么多成员的分类。

类型:整数
acmax

只返回最多带这么多成员的分类。

类型:整数
aclimit

要返回多少个类别。

类型:整数或max
值必须介于1和500之间。
默认:10
acprop

要获取的属性:

size
在分类中添加页面数。
hidden
标记由__HIDDENCAT__隐藏的分类。
值(以|替代物分隔):hidden、size
默认:(空)
例子:
列出分类及其含有多少页面的信息。
api.php?action=query&list=allcategories&acprop=size [在沙盒中打开]
为以List的分类检索有关分类页面本身的信息。
api.php?action=query&generator=allcategories&gacprefix=List&prop=info [在沙盒中打开]

list=alldeletedrevisions (adr)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

列举由一位用户或在一个命名空间中所有已删除的修订。

参数:
adrprop

要为每个修订获取的属性:

ids
修订版本的ID。
flags
修订标记(小编辑)。
timestamp
修订的时间戳。
user
进行修订的用户。如果用户已被版本删除,将返回userhidden属性。
userid
修订创建者的用户ID。如果用户已被版本删除,将返回userhidden属性。
size
修订的长度(字节)。
slotsize
每次修订间隔的长度(字节)。
sha1
修订版的SHA-1(base 16)。如果内容已被版本删除,将返回sha1hidden属性。
slotsha1
每次修订间隔的SHA-1(base 16)。如果内容已被版本删除,将返回sha1hidden属性。
contentmodel
每次修订间隔的内容模型ID。
comment
用户对修订的评论。如果评论已被版本删除,将返回commenthidden属性。
parsedcomment
用户对修订的解析注释。如果评论已被版本删除,将返回commenthidden属性。
content
每次修订间隔的内容。如果内容已被版本删除,将返回texthidden属性。
tags
修订标签。
roles
List content slot roles that exist in the revision.
parsetree
已弃用。请改用action=expandtemplatesaction=parse。修订内容的XML解析树(需要内容模型wikitext)。
值(以|替代物分隔):comment、content、contentmodel、flags、ids、parsedcomment、roles、sha1、size、slotsha1、slotsize、tags、timestamp、user、userid、parsetree
默认:ids|timestamp|flags|comment|user
adrslots

Which revision slots to return data for, when slot-related properties are included in adrprops. If omitted, data from the main slot will be returned in a backwards-compatible format.

值(以|替代物分隔):main
要指定所有值,请使用*
adrlimit

限制返回多少修订。

类型:整数或max
值必须介于1和500之间。
adrexpandtemplates
已弃用。

请改用action=expandtemplates。展开修订内容中的模板(需要adrprop=content)。

类型:布尔型 (详情)
adrgeneratexml
已弃用。

请改用action=expandtemplatesaction=parse。生成用于修订内容的XML解析树(需要adrprop=content;被adrprop=parsetree所取代)。

类型:布尔型 (详情)
adrparse
已弃用。

请改用action=parse。解析修订内容(需要adrprop=content)。由于性能原因,如果此选项被使用,adrlimit会被强制为1。

类型:布尔型 (详情)
adrsection

只检索此段落数的内容。

adrdiffto
已弃用。

请改用action=compare。要比较修订差异的修订ID。使用prevnextcur分别用于上个、下个和当前修订。

adrdifftotext
已弃用。

请改用action=compare。要比较修订差异的文本。只有修订的有限数字内的差异。覆盖adrdiffto。如果adrsection被设置,只有那个段落将与此文本之间比较差异

adrdifftotextpst
已弃用。

请改用action=compare。在编辑文本前对其执行预保存转换。只当与adrdifftotext一起使用时有效。

类型:布尔型 (详情)
adrcontentformat
已弃用。

序列化用于adrdifftotext的格式并预估内容输出。

以下值中的一个:application/json、application/octet-stream、application/unknown、application/x-binary、text/css、text/javascript、text/plain、text/unknown、text/x-wiki、unknown/unknown
adruser

只列出此用户做出的修订。

类型:通过 用户名、IP、跨wiki用户名(例如“前缀>示例用户”)和用户ID(例如“#12345”) 中任意一种方式指定的用户
adrnamespace

只列出此命名空间的页面。

值(以|替代物分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
要指定所有值,请使用*
adrstart

枚举的起始时间戳。

只可以与adruser一起使用。
类型:时间戳(允许格式
adrend

枚举的结束时间戳。

只可以与adruser一起使用。
类型:时间戳(允许格式
adrdir

列举的方向:

newer
最早的优先。注意:adrstart应早于adrend。
older
最新的优先(默认)。注意:adrstart应晚于adrend。
以下值中的一个:newer、older
默认:older
adrfrom

从此标题开始列出。

不能与adruser一起使用。
adrto

列出至此标题为止。

不能与adruser一起使用。
adrprefix

搜索所有以此值开头的页面标题。

不能与adruser一起使用。
adrexcludeuser

不要列出此用户做出的修订。

不能与adruser一起使用。
类型:通过 用户名、IP、跨wiki用户名(例如“前缀>示例用户”)和用户ID(例如“#12345”) 中任意一种方式指定的用户
adrtag

只列出被此标签标记的修订。

adrcontinue

当更多结果可用时,使用这个继续。

adrgeneratetitles

当作为生成器使用时,生成标题而不是修订ID。

类型:布尔型 (详情)

list=allfileusages (af)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

列出所有文件用途,包括不存在的。

参数:
afcontinue

当更多结果可用时,使用这个继续。

affrom

要列举的起始文件标题。

afto

要列举的最终文件标题。

afprefix

搜索所有以此值开头的文件标题。

afunique

只显示明显的文件标题。不能与afprop=ids一起使用。 当作为生成器使用时,产生目标页面而不是来源页面。

类型:布尔型 (详情)
afprop

要包含的信息束:

ids
添加使用中的页面的页面ID(不能与afunique一起使用)。
title
添加文件的标题。
值(以|替代物分隔):ids、title
默认:title
aflimit

要返回的总计项目。

类型:整数或max
值必须介于1和500之间。
默认:10
afdir

罗列所采用的方向。

以下值中的一个:ascending、descending
默认:ascending

list=allimages (ai)

main | query | allimages
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

按顺序枚举所有图像。

参数:
aisort

要作为排序方式的属性。

以下值中的一个:name、timestamp
默认:name
aidir

罗列所采用的方向。

以下值中的一个:ascending、descending、newer、older
默认:ascending
aifrom

要列举的起始图片标题。只能与aisort=name一起使用。

aito

要列举的最终图片标题。只能与aisort=name一起使用。

aicontinue

当更多结果可用时,使用这个继续。

aistart

要列举的起始时间戳。只能与aisort=timestamp一起使用。

类型:时间戳(允许格式
aiend

要列举的最终时间戳。只能与aisort=timestamp一起使用。

类型:时间戳(允许格式
aiprop

要获取的文件信息:

timestamp
添加时间戳至上传的版本。
user
添加上传了各个文件版本的用户。若该用户已被删除修订,将返回userhidden属性。
userid
添加上传了各个文件版本的用户的 ID。若该用户已被删除修订,将返回userhidden属性。
comment
此版本的摘要。若该用户已被删除修订,将返回userhidden属性。
parsedcomment
解析版本上的注释。若该注释已被删除修订,将返回commenthidden属性。
canonicaltitle
添加文件的规范标题。若该文件已被删除修订,将返回filehidden属性。
url
为文件及其描述页面提供 URL。若该文件已被删除修订,将返回filehidden属性。
size
添加文件大小(字节)及其高度、宽度和页面数(如果可以)。
dimensions
用于大小的别名。
sha1
为文件加入 SHA-1 哈希值。若该文件已被删除修订,将返回filehidden属性。
mime
添加文件的 MIME 类型。若该文件已被删除修订,将返回filehidden属性。
mediatype
添加文件媒体类型。若该文件已被删除修订,将返回filehidden属性。
metadata
列出这个版本的文件的 EXIF 元数据。若该文件已被删除修订,将返回filehidden属性。
commonmetadata
为文件的修订版本列出文件格式通用元数据。若该文件已被删除修订,将返回filehidden属性。
extmetadata
列出结合自多个来源的格式化的元数据。结果均依HTML格式化。如果文件已被修订删除,filehidden 属性会被退回。
bitdepth
添加修订的字节深度。若该文件已被删除修订,将返回 filehidden 属性。
badfile
无论文件是否在MediaWiki:Bad image list都添加
值(以|替代物分隔):badfile、bitdepth、canonicaltitle、comment、commonmetadata、dimensions、extmetadata、mediatype、metadata、mime、parsedcomment、sha1、size、timestamp、url、user、userid
默认:timestamp|url
aiprefix

搜索所有以此值开头的图像标题。只能与aisort=name一起使用。

aiminsize

限于至少这么多字节的图像。

类型:整数
aimaxsize

限于顶多这么多字节的图像。

类型:整数
aisha1

图像的 SHA1 哈希。覆盖aisha1base36。

aisha1base36

基于base 36的图片的SHA1哈希值(用于MediaWiki)。

aiuser

只返回此用户上传的文件。只能与aisort=timestamp一起使用。不能与aifilterbots一起使用。

类型:通过 用户名、IP、跨wiki用户名(例如“前缀>示例用户”)和用户ID(例如“#12345”) 中任意一种方式指定的用户
aifilterbots

如何过滤由机器人上传的文件。只能与aisort=timestamp一起使用。不能与aiuser一起使用。

以下值中的一个:all、bots、nobots
默认:all
aimime

要搜索的MIME类型,例如image/jpeg

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
ailimit

共计要返回多少图像。

类型:整数或max
值必须介于1和500之间。
默认:10
main | query | alllinks
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

列举所有指向至指定命名空间的链接。

参数:
alcontinue

当更多结果可用时,使用这个继续。

alfrom

要列举的起始标题链接。

alto

要列举的最终标题链接。

alprefix

搜索所有以此值开头的已链接标题。

alunique

只显示明显的链接标题。不能与alprop=ids一起使用。 当作为生成器使用时,产生目标页面而不是来源页面。

类型:布尔型 (详情)
alprop

要包含的信息束:

ids
添加链接中的页面的页面ID(不能与alunique一起使用)。
title
添加链接的标题。
值(以|替代物分隔):ids、title
默认:title
alnamespace

要列举的命名空间。

以下值中的一个:-1、-2、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
默认:0
allimit

总共要返回多少个项目。

类型:整数或max
值必须介于1和500之间。
默认:10
aldir

列出方向。

以下值中的一个:ascending、descending
默认:ascending
例子:
列出链接的标题,包括丢失的,带它们来自的页面ID,以B开头。
api.php?action=query&list=alllinks&alfrom=B&alprop=ids|title [在沙盒中打开]
列出唯一的链接标题。
api.php?action=query&list=alllinks&alunique=&alfrom=B [在沙盒中打开]
获取所有已链接的标题,标记缺少的。
api.php?action=query&generator=alllinks&galunique=&galfrom=B [在沙盒中打开]
获取包含这些链接的页面。
api.php?action=query&generator=alllinks&galfrom=B [在沙盒中打开]

list=allpages (ap)

main | query | allpages
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

循序列举在指定命名空间中的所有页面。

参数:
apfrom

枚举的起始页面标题。

apcontinue

当更多结果可用时,使用这个继续。

apto

枚举的结束页面标题。

apprefix

搜索所有以此值开头的页面标题。

apnamespace

要列举的命名空间。

以下值中的一个:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
默认:0
apfilterredir

要列出哪些页面。

以下值中的一个:all、nonredirects、redirects
默认:all
apminsize

限于至少这么多字节的页面。

类型:整数
apmaxsize

限于至多这么多字节的页面。

类型:整数
apprtype

仅限于受保护页面。

值(以|替代物分隔):edit、move、upload
apprlevel

过滤基于保护等级的保护(必须与apprtype=参数一起使用)。

值(以|替代物分隔):可以为空,或autoconfirmed、sysop
apprfiltercascade

过滤基于cascadingness的保护(当apprtype未设置时忽略)。

以下值中的一个:all、cascading、noncascading
默认:all
aplimit

返回的总计页面数。

类型:整数或max
值必须介于1和500之间。
默认:10
apdir

罗列所采用的方向。

以下值中的一个:ascending、descending
默认:ascending
apfilterlanglinks

过滤基于页面是否有语言链接。注意这可能不考虑由扩展添加的语言链接。

以下值中的一个:all、withlanglinks、withoutlanglinks
默认:all
apprexpiry

要在页面上过滤的保护期限:

indefinite
只获取带无限期保护的页面。
definite
只获取带指定保护期限的页面。
all
获取任意保护期限的页面。
以下值中的一个:all、definite、indefinite
默认:all

list=allredirects (ar)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

列出至一个命名空间的重定向。

参数:
arcontinue

当更多结果可用时,使用这个继续。

arfrom

要列举的起始重定向标题。

arto

要列举的最终重定向标题。

arprefix

搜索所有以此值开头的目标页面。

arunique

只显示明显的目标页面。不能与arprop=ids|fragment|interwiki一起使用。 当作为生成器使用时,产生目标页面而不是来源页面。

类型:布尔型 (详情)
arprop

要包含的信息束:

ids
添加重定向页面的页面ID(不能与arunique一起使用)。
title
添加重定向的标题。
fragment
添加来自重定向的碎片,如果有(不能与arunique一起使用)。
interwiki
添加来自重定向的跨wiki前缀,如果有(不能与arunique一起使用)。
值(以|替代物分隔):fragment、ids、interwiki、title
默认:title
arnamespace

要列举的命名空间。

以下值中的一个:-1、-2、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
默认:0
arlimit

返回的总计项目数。

类型:整数或max
值必须介于1和500之间。
默认:10
ardir

罗列所采用的方向。

以下值中的一个:ascending、descending
默认:ascending

list=allrevisions (arv)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

列举所有修订。

参数:
arvprop

要为每个修订获取的属性:

ids
修订版本的ID。
flags
修订标记(小编辑)。
timestamp
修订的时间戳。
user
进行修订的用户。如果用户已被版本删除,将返回userhidden属性。
userid
修订创建者的用户ID。如果用户已被版本删除,将返回userhidden属性。
size
修订的长度(字节)。
slotsize
每次修订间隔的长度(字节)。
sha1
修订版的SHA-1(base 16)。如果内容已被版本删除,将返回sha1hidden属性。
slotsha1
每次修订间隔的SHA-1(base 16)。如果内容已被版本删除,将返回sha1hidden属性。
contentmodel
每次修订间隔的内容模型ID。
comment
用户对修订的评论。如果评论已被版本删除,将返回commenthidden属性。
parsedcomment
用户对修订的解析注释。如果评论已被版本删除,将返回commenthidden属性。
content
每次修订间隔的内容。如果内容已被版本删除,将返回texthidden属性。
tags
修订标签。
roles
List content slot roles that exist in the revision.
parsetree
已弃用。请改用action=expandtemplatesaction=parse。修订内容的XML解析树(需要内容模型wikitext)。
值(以|替代物分隔):comment、content、contentmodel、flags、ids、parsedcomment、roles、sha1、size、slotsha1、slotsize、tags、timestamp、user、userid、parsetree
默认:ids|timestamp|flags|comment|user
arvslots

Which revision slots to return data for, when slot-related properties are included in arvprops. If omitted, data from the main slot will be returned in a backwards-compatible format.

值(以|替代物分隔):main
要指定所有值,请使用*
arvlimit

限制返回多少修订。

类型:整数或max
值必须介于1和500之间。
arvexpandtemplates
已弃用。

请改用action=expandtemplates。展开修订内容中的模板(需要arvprop=content)。

类型:布尔型 (详情)
arvgeneratexml
已弃用。

请改用action=expandtemplatesaction=parse。生成用于修订内容的XML解析树(需要arvprop=content;被arvprop=parsetree所取代)。

类型:布尔型 (详情)
arvparse
已弃用。

请改用action=parse。解析修订内容(需要arvprop=content)。由于性能原因,如果此选项被使用,arvlimit会被强制为1。

类型:布尔型 (详情)
arvsection

只检索此段落数的内容。

arvdiffto
已弃用。

请改用action=compare。要比较修订差异的修订ID。使用prevnextcur分别用于上个、下个和当前修订。

arvdifftotext
已弃用。

请改用action=compare。要比较修订差异的文本。只有修订的有限数字内的差异。覆盖arvdiffto。如果arvsection被设置,只有那个段落将与此文本之间比较差异

arvdifftotextpst
已弃用。

请改用action=compare。在编辑文本前对其执行预保存转换。只当与arvdifftotext一起使用时有效。

类型:布尔型 (详情)
arvcontentformat
已弃用。

序列化用于arvdifftotext的格式并预估内容输出。

以下值中的一个:application/json、application/octet-stream、application/unknown、application/x-binary、text/css、text/javascript、text/plain、text/unknown、text/x-wiki、unknown/unknown
arvuser

只列出此用户做出的修订。

类型:通过 用户名、IP、跨wiki用户名(例如“前缀>示例用户”)和用户ID(例如“#12345”) 中任意一种方式指定的用户
arvnamespace

只列出此命名空间的页面。

值(以|替代物分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
要指定所有值,请使用*
arvstart

枚举的起始时间戳。

类型:时间戳(允许格式
arvend

枚举的结束时间戳。

类型:时间戳(允许格式
arvdir

列举的方向:

newer
最早的优先。注意:arvstart应早于arvend。
older
最新的优先(默认)。注意:arvstart应晚于arvend。
以下值中的一个:newer、older
默认:older
arvexcludeuser

不要列出此用户做出的修订。

类型:通过 用户名、IP、跨wiki用户名(例如“前缀>示例用户”)和用户ID(例如“#12345”) 中任意一种方式指定的用户
arvcontinue

当更多结果可用时,使用这个继续。

arvgeneratetitles

当作为生成器使用时,生成标题而不是修订ID。

类型:布尔型 (详情)

list=alltransclusions (at)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

列出所有嵌入页面(使用{{x}}嵌入的页面),包括不存在的。

参数:
atcontinue

当更多结果可用时,使用这个继续。

atfrom

要列举的起始嵌入标题。

atto

要列举的最终嵌入标题。

atprefix

搜索所有以此值开头的嵌入的标题。

atunique

只显示明显的被嵌入标题。不能与atprop=ids一起使用。 当作为生成器使用时,产生目标页面而不是来源页面。

类型:布尔型 (详情)
atprop

要包含的信息束:

ids
添加嵌入中的页面的页面ID(不能与atunique一起使用)。
title
添加嵌入的标题。
值(以|替代物分隔):ids、title
默认:title
atnamespace

要列举的命名空间。

以下值中的一个:-1、-2、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
默认:10
atlimit

要返回的总计项目。

类型:整数或max
值必须介于1和500之间。
默认:10
atdir

罗列所采用的方向。

以下值中的一个:ascending、descending
默认:ascending

list=allusers (au)

main | query | allusers

列举所有注册用户。

参数:
aufrom

枚举的起始用户名。

auto

枚举的结束用户名。

auprefix

搜索所有以此值开头的用户。

audir

排序方向。

以下值中的一个:ascending、descending
默认:ascending
augroup

只包含指定组中的用户。

值(以|替代物分隔):automoderated、bilibili、bot、bureaucrat、checkuser、interface-admin、moderator、push-subscription-manager、smwadministrator、smwcurator、smweditor、suppress、sysop、widgeteditor
auexcludegroup

排除指定组中的用户。

值(以|替代物分隔):automoderated、bilibili、bot、bureaucrat、checkuser、interface-admin、moderator、push-subscription-manager、smwadministrator、smwcurator、smweditor、suppress、sysop、widgeteditor
aurights

仅列出有所选权限的用户。不包括隐性的或自动加入的用户组别(如*、用户或自动确认用户)所授予的权限。

值(以|替代物分隔):BApi-right、BatchImportData-right、ModerationAdmin-right、UploadLogo-right、abusefilter-hidden-log、abusefilter-hide-log、abusefilter-log、abusefilter-log-detail、abusefilter-log-private、abusefilter-modify、abusefilter-modify-global、abusefilter-modify-restricted、abusefilter-privatedetails、abusefilter-privatedetails-log、abusefilter-revert、abusefilter-view、abusefilter-view-private、ajaxpoll-view-results、ajaxpoll-view-results-before-vote、ajaxpoll-vote、apihighlimits、applychangetags、autoconfirmed、autocreateaccount、autopatrol、bigdelete、block、blockemail、bot、browsearchive、changetags、comment、commentadmin、commentadmin-restricted、createaccount、createclass、createpage、createtalk、delete、delete-redirect、deletechangetags、deletedhistory、deletedtext、deletelogentry、deleterevision、dpl_param_delete_rules、dpl_param_update_rules、edit、editcontentmodel、editinterface、editmyoptions、editmyprivateinfo、editmyusercss、editmyuserjs、editmyuserjson、editmyuserjsredirect、editmywatchlist、editprotected、editrestrictedfields、editsemiprotected、editsitecss、editsitejs、editsitejson、editusercss、edituserjs、edituserjson、editwidgets、gadgets-definition-edit、gadgets-edit、hideuser、import、importupload、interwiki、ipblock-exempt、manage-all-push-subscriptions、managechangetags、markbotedits、mergehistory、minoredit、moderation、move、move-categorypages、move-rootuserpages、move-subpages、movefile、multipageedit、namespaces、nominornewtalk、noratelimit、nuke、override-export-depth、pagelang、patrol、patrolmarks、protect、purge、read、renameuser、replacetext、reupload、reupload-own、reupload-shared、rollback、sendemail、siteadmin、skip-moderation、skip-move-moderation、skipcaptcha、smw-admin、smw-pageedit、smw-patternedit、smw-schemaedit、smw-vieweditpageinfo、smw-viewentityassociatedrevisionmismatch、smw-viewjobqueuewatchlist、spamblacklistlog、suppressionlog、suppressredirect、suppressrevision、tboverride、tboverride-account、titleblacklistlog、unblockself、undelete、unwatchedpages、upload、upload_by_url、userrights、userrights-interwiki、viewedittab、viewmyprivateinfo、viewmywatchlist、viewsuppressed、writeapi
值的最大值为50(允许更高上限的客户端为500)。
auprop

要包含的信息束:

blockinfo
添加有关用户当前封禁的信息。
groups
列举用户所在的组。这使用更多服务器资源,并可能返回少于限制的结果。
implicitgroups
列出用户自动属于的所有组。
rights
用户拥有的权限列表。
editcount
添加用户的编辑计数。
registration
如果可能,添加用户注册时的时间戳(可能为空白)。
centralids
添加中心ID并为用户附加状态。
值(以|替代物分隔):blockinfo、centralids、editcount、groups、implicitgroups、registration、rights
aulimit

返回的总计用户数。

类型:整数或max
值必须介于1和500之间。
默认:10
auwitheditsonly

只列出有编辑的用户。

类型:布尔型 (详情)
auactiveusers

只列出最近30天内活跃的用户。

类型:布尔型 (详情)
auattachedwiki

auprop=centralids一起使用,也表明用户是否附加于此ID定义的wiki。

main | query | backlinks
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

查找所有链接至指定页面的页面。

参数:
bltitle

要搜索的标题。不能与blpageid一起使用。

blpageid

要搜索的页面ID。不能与bltitle一起使用。

类型:整数
blcontinue

当更多结果可用时,使用这个继续。

blnamespace

要列举的命名空间。

值(以|替代物分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
要指定所有值,请使用*
bldir

罗列所采用的方向。

以下值中的一个:ascending、descending
默认:ascending
blfilterredir

如何过滤重定向。当blredirect被启用时如果设置为nonredirects,这只会应用到第二级。

以下值中的一个:all、nonredirects、redirects
默认:all
bllimit

返回总计页面数。如果blredirect被启用,则限定分别适用于每一等级(这意味着将返回多达2 * bllimit个结果)。

类型:整数或max
值必须介于1和500之间。
默认:10
blredirect

如果链入页面是一个重定向,则寻找所有链接至此重定向的页面。最大限制减半。

类型:布尔型 (详情)

list=blocks (bk)

main | query | blocks

列出所有被封禁的用户和IP地址。

参数:
bkstart

枚举的起始时间戳。

类型:时间戳(允许格式
bkend

枚举的结束时间戳。

类型:时间戳(允许格式
bkdir

列举的方向:

newer
最早的优先。注意:bkstart应早于bkend。
older
最新的优先(默认)。注意:bkstart应晚于bkend。
以下值中的一个:newer、older
默认:older
bkids

要列出的封禁ID列表(可选)。

类型:整数列表
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
bkusers

要搜索的用户列表(可选)。

类型:通过 用户名、IP和IP范围 中任意一种方式指定的用户列表
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
bkip

获取应用到此IP地址或者CIDR范围的所有封禁,包括范围封禁。不能与bkusers一起使用。CIDR范围不允许比IPv4/16或IPv6/19更宽。

bklimit

封禁列表的最大数量。

类型:整数或max
值必须介于1和500之间。
默认:10
bkprop

要获取的属性:

id
添加封禁ID。
user
添加被封禁用户的用户名。
userid
添加被封禁用户的用户ID。
by
添加执行封禁的用户的用户名。
byid
添加执行封禁的用户的用户ID。
timestamp
添加封禁生效时的时间戳。
expiry
添加封禁截止时的时间戳。
reason
添加封禁原因。
range
添加受封禁影响的IP地址段。
flags
标记编辑禁止(自动封禁、仅限匿名用户等)。
restrictions
添加部分封禁限制,当该封禁不是全站封禁。
值(以|替代物分隔):by、byid、expiry、flags、id、range、reason、restrictions、timestamp、user、userid
默认:id|user|by|timestamp|expiry|reason|flags
bkshow

只显示符合这些标准的项目。 例如,要只查看IP地址的无限期封禁,设置bkshow=ip|!temp

值(以|替代物分隔):!account、!ip、!range、!temp、account、ip、range、temp
bkcontinue

当更多结果可用时,使用这个继续。

list=categorymembers (cm)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

在指定的分类中列出所有页面。

参数:
cmtitle

要列举的分类(必需)。必须包括分类:前缀。不能与cmpageid一起使用。

cmpageid

要枚举的分类的页面 ID。不能与cmtitle一起使用。

类型:整数
cmprop

要包含的信息束:

ids
添加页面ID。
title
添加页面标题和命名空间ID。
sortkey
添加用于分类中排序的关键字(十六进制字符串)。
sortkeyprefix
添加用于分类中排序的关键字前缀(关键字的人类可读部分)。
type
添加页面被分类的类型(pagesubcatfile)。
timestamp
添加页面被包括时的时间戳。
值(以|替代物分隔):ids、sortkey、sortkeyprefix、timestamp、title、type
默认:ids|title
cmnamespace

仅包含这些命名空间的页面。注意可使用cmtype=subcatcmtype=file替代cmnamespace=146

值(以|替代物分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
要指定所有值,请使用*
cmtype

包含的分类成员类型。当cmsort=timestamp被设置时会忽略。

值(以|替代物分隔):file、page、subcat
默认:page|subcat|file
cmcontinue

当更多结果可用时,使用这个继续。

cmlimit

返回页面的最大数量。

类型:整数或max
值必须介于1和500之间。
默认:10
cmsort

要作为排序方式的属性。

以下值中的一个:sortkey、timestamp
默认:sortkey
cmdir

排序的方向。

以下值中的一个:asc、ascending、desc、descending、newer、older
默认:ascending
cmstart

开始列举的时间戳。只能与cmsort=timestamp一起使用。

类型:时间戳(允许格式
cmend

列举的结尾时间戳。只能与cmsort=timestamp一起使用。

类型:时间戳(允许格式
cmstarthexsortkey

开始列举的关键词,由cmprop=sortkey返回。不能与cmsort=sortkey一起使用。

cmendhexsortkey

结束列举的关键字,由cmprop=sortkey返回。只能与cmsort=sortkey一起使用。

cmstartsortkeyprefix

要开始列举的排序关键词前缀。只能与cmsort=sortkey一起使用。覆盖cmstarthexsortkey

cmendsortkeyprefix

要结束列举before的关键字前缀(而不是at;如果此值出现,它将不被包括!)只能与cmsort=sortkey一起使用。覆盖cmendhexsortkey。

cmstartsortkey
已弃用。

请改用cmstarthexsortkey。

cmendsortkey
已弃用。

请改用cmendhexsortkey。

list=deletedrevs (dr)

  • 此模块已弃用。
  • 此模块需要读取权限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

列举删除的修订版本。

操作于三种模式中:

  1. 为指定标题列举已删除修订,按时间戳排列。
  2. 为指定用户列举已删除贡献,按时间戳排列(未指定标题)。
  3. 在指定命名空间中列举所有已删除修订,按标题和时间戳排列(无指定标题,未设置druser)。

任一参数只应用于一些模式,并忽略其他参数。

参数:
drstart

枚举的起始时间戳。

模式:1、2
类型:时间戳(允许格式
drend

枚举的结束时间戳。

模式:1、2
类型:时间戳(允许格式
drdir

列举的方向:

newer
最早的优先。注意:drstart应早于drend。
older
最新的优先(默认)。注意:drstart应晚于drend。
模式:1、3
以下值中的一个:newer、older
默认:older
drfrom

从此标题开始列出。

模式:3
drto

列出至此标题为止。

模式:3
drprefix

搜索所有以此值开头的页面标题。

模式:3
drunique

每个页面只列出一个修订。

模式:3
类型:布尔型 (详情)
drnamespace

只列出此命名空间的页面。

模式:3
以下值中的一个:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
默认:0
drtag

只列出被此标签标记的修订。

druser

只列出此用户做出的修订。

类型:通过 用户名、IP、跨wiki用户名(例如“前缀>示例用户”)和用户ID(例如“#12345”) 中任意一种方式指定的用户
drexcludeuser

不要列出此用户做出的修订。

类型:通过 用户名、IP、跨wiki用户名(例如“前缀>示例用户”)和用户ID(例如“#12345”) 中任意一种方式指定的用户
drprop

要获取的属性:

revid
添加被删除修订的修订ID。
parentid
添加上一修订的修订ID至页面。
user
添加做出修订的用户。
userid
添加做出修订的用户ID。
comment
添加修订摘要。
parsedcomment
添加解析过的修订摘要。
minor
如果修订是小编辑则加标签。
len
添加修订长度(字节)。
sha1
添加修订的SHA-1(base 16)。
content
添加修订内容。
token
已弃用。提供编辑令牌。
tags
修订标签。
值(以|替代物分隔):comment、content、len、minor、parentid、parsedcomment、revid、sha1、tags、token、user、userid
默认:user|comment
drlimit

要列出的最大修订数量。

类型:整数或max
值必须介于1和500之间。
默认:10
drcontinue

当更多结果可用时,使用这个继续。

例子:
列出最近已删除的对页面Main PageTalk:Main Page的贡献,带内容(模式1)。
api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&drprop=user|comment|content [在沙盒中打开]
列出由Bob作出的最近50次已删除贡献(模式2)。
api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50 [在沙盒中打开]
列出前50次主命名空间已删除贡献(模式3)。
api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50 [在沙盒中打开]
列出前50次讨论命名空间已删除页面(模式3)。
api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique= [在沙盒中打开]

list=embeddedin (ei)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

查找所有嵌入指定标题的页面。

参数:
eititle

要搜索的标题。不能与eipageid一起使用。

eipageid

要搜索的页面ID。不能与eititle一起使用。

类型:整数
eicontinue

当更多结果可用时,使用这个继续。

einamespace

列举的命名空间。

值(以|替代物分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
要指定所有值,请使用*
eidir

罗列所采用的方向。

以下值中的一个:ascending、descending
默认:ascending
eifilterredir

如何过滤重定向。

以下值中的一个:all、nonredirects、redirects
默认:all
eilimit

返回的总计页面数。

类型:整数或max
值必须介于1和500之间。
默认:10

list=exturlusage (eu)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

列举包含一个指定URL的页面。

参数:
euprop

要包含的信息束:

ids
添加页面ID。
title
添加页面的标题和命名空间ID。
url
添加页面中使用的URL。
值(以|替代物分隔):ids、title、url
默认:ids|title|url
eucontinue

当更多结果可用时,使用这个继续。

euprotocol

URL协议。如果为空并且euquery被设置,协议为http。将此和euquery都留空以列举所有外部链接。

以下值中的一个:可以为空,或bitcoin、ftp、ftps、geo、git、gopher、http、https、irc、ircs、magnet、mailto、mms、news、nntp、redis、sftp、sip、sips、sms、ssh、svn、tel、telnet、urn、worldwind、xmpp
默认:(空)
euquery

不包括协议的搜索字符串。参见Special:LinkSearch。留空以列出所有外部链接。

eunamespace

要列举的页面命名空间。

值(以|替代物分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
要指定所有值,请使用*
eulimit

返回多少页面。

类型:整数或max
值必须介于1和500之间。
默认:10
euexpandurl

用标准协议展开协议相关URL。

类型:布尔型 (详情)

list=filearchive (fa)

循序列举所有被删除的文件。

参数:
fafrom

枚举的起始图片标题。

fato

枚举的结束图片标题。

faprefix

搜索所有以此值开头的图像标题。

fadir

罗列所采用的方向。

以下值中的一个:ascending、descending
默认:ascending
fasha1

图片的SHA1哈希值。覆盖fasha1base36。

fasha1base36

基于base 36的图片的SHA1哈希值(用于MediaWiki)。

faprop

要获取的图片信息:

sha1
为文件加入SHA-1哈希值。
timestamp
为已上传版本添加时间戳。
user
添加上传了图片版本的用户。
size
添加图片大小(字节)及其高度、宽度和页面计数(如果可以)。
dimensions
用于大小的别名。
description
添加图片版本的说明。
parseddescription
解析版本的描述。
mime
添加图片的MIME。
mediatype
添加图片的媒体类型。
metadata
为图片版本列出Exif元数据。
bitdepth
添加版本的字节深度。
archivename
添加用于非最新版本的存档版本的文件名。
值(以|替代物分隔):archivename、bitdepth、description、dimensions、mediatype、metadata、mime、parseddescription、sha1、size、timestamp、user
默认:timestamp
falimit

返回图像的总数。

类型:整数或max
值必须介于1和500之间。
默认:10
facontinue

当更多结果可用时,使用这个继续。

例子:
显示已删除文件列表。
api.php?action=query&list=filearchive [在沙盒中打开]

list=gadgetcategories (gc)

返回小工具分类列表。

参数:
gcprop

要获取的小工具分类信息:

name
内部分类名称。
title
分类标题。
members
分类中的小工具数量。
值(以|替代物分隔):members、name、title
默认:name
gcnames

要获取的分类名。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
例子:
获取现有小工具分类的列表
api.php?action=query&list=gadgetcategories [在沙盒中打开]
获取所有有关名称为“foo”和“bar”的分类的信息
api.php?action=query&list=gadgetcategories&gcnames=foo|bar&gcprop=name|title|members [在沙盒中打开]

list=gadgets (ga)

main | query | gadgets

返回一个本Wiki上的小工具的列表。

参数:
gaprop

要获取的小工具信息:

id
内部小工具ID。
metadata
小工具元数据。
desc
小工具说明转换成HTML(较慢,只在需要的时候使用)。
值(以|替代物分隔):desc、id、metadata
默认:id|metadata
gacategories

来自要检索的分类的小工具。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
gaids

要检索的小工具ID。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
gaallowedonly

只列出允许当前用户使用的小工具。

类型:布尔型 (详情)
gaenabledonly

只列出当前用户启用的小工具。

类型:布尔型 (详情)

list=imageusage (iu)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

查找所有使用指定图片标题的页面。

参数:
iutitle

要搜索的标题。不能与iupageid一起使用。

iupageid

要搜索的页面ID。不能与iutitle一起使用。

类型:整数
iucontinue

当更多结果可用时,使用这个继续。

iunamespace

要列举的命名空间。

值(以|替代物分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
要指定所有值,请使用*
iudir

罗列所采用的方向。

以下值中的一个:ascending、descending
默认:ascending
iufilterredir

如何过滤重定向。当iuredirect被启用时如果设置为nonredirects,这只会应用到第二级。

以下值中的一个:all、nonredirects、redirects
默认:all
iulimit

返回总计页面数。如果iuredirect被启用,则限定分别适用于每一等级(这意味着将返回多达2 * iulimit个结果)。

类型:整数或max
值必须介于1和500之间。
默认:10
iuredirect

如果链接页面是重定向,则查找所有链接至该重定向的页面。最大限制减半。

类型:布尔型 (详情)
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

查找所有链接至指定跨wiki链接的页面。

可用于查找所有有前缀的链接,或是链至某一标题的所有链接(带指定前缀)。两参数均不使用实际上就是“all interwiki links”。

参数:
iwblprefix

跨wiki前缀。

iwbltitle

要搜索的跨wiki链接。必须与iwblblprefix一起使用。

iwblcontinue

当更多结果可用时,使用这个继续。

iwbllimit

返回的总计页面数。

类型:整数或max
值必须介于1和500之间。
默认:10
iwblprop

要获取的属性:

iwprefix
加入跨wiki前缀。
iwtitle
加入跨wiki标题。
值(以|替代物分隔):iwprefix、iwtitle
默认:(空)
iwbldir

罗列所采用的方向。

以下值中的一个:ascending、descending
默认:ascending
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

查找所有链接至指定语言链接的页面。

可被用于查找所有带某一语言代码的链接,或所有至某一标题的链接(带指定语言)。不使用任何参数就意味着“all language links”。

注意这可能不考虑由扩展添加的语言链接。

参数:
lbllang

用于语言链接的语言。

lbltitle

要搜索的语言链接。必须与lbllang一起使用。

lblcontinue

当更多结果可用时,使用这个继续。

lbllimit

返回的总计页面数。

类型:整数或max
值必须介于1和500之间。
默认:10
lblprop

要获得的属性:

lllang
添加语言链接的语言代码。
lltitle
添加语言链接的标题。
值(以|替代物分隔):lllang、lltitle
默认:(空)
lbldir

罗列所采用的方向。

以下值中的一个:ascending、descending
默认:ascending

list=logevents (le)

main | query | logevents

从日志获取事件。

参数:
leprop

要获取的属性:

ids
添加日志活动的ID。
title
为日志事件添加页面标题。
type
添加日志活动的类型。
user
添加负责日志事件的用户。如果用户已被修订删除,将返回userhidden属性。
userid
添加负责日志事件的用户ID。如果用户已被修订删除,将返回userhidden属性。
timestamp
为日志活动添加时间戳。
comment
添加日志事件的评论。如果评论已被修订删除,将返回commenthidden属性。
parsedcomment
添加日志事件的解析评论。如果评论已被修订删除,将返回commenthidden属性。
details
列出有关日志事件的其他详细信息。如果日志事件已被修订删除,则将返回actionhidden属性。
tags
列举用于日志活动的标签。
值(以|替代物分隔):comment、details、ids、parsedcomment、tags、timestamp、title、type、user、userid
默认:ids|title|type|user|timestamp|comment|details
letype

过滤日志记录至仅限此类型。

以下值中的一个:可以为空,或abusefilter、abusefilterprivatedetails、block、comments、contentmodel、create、delete、import、interwiki、managetags、merge、moderation、move、namespaces、newusers、patrol、protect、renameuser、rights、smw、spamblacklist、suppress、tag、titleblacklist、upload
leaction

过滤日志操作为仅限此操作。覆盖letype。在可用值列表中,带星号通配符的值例如action/*可在斜线(/)后拥有不同字符串。

以下值中的一个:abusefilter/create、abusefilter/hit、abusefilter/modify、abusefilterprivatedetails/access、block/block、block/reblock、block/unblock、comments/delete、comments/disable、comments/enable、comments/erase、comments/import、comments/markchecked、comments/recover、contentmodel/change、contentmodel/new、create/create、delete/delete、delete/delete_redir、delete/delete_redir2、delete/event、delete/restore、delete/revision、import/interwiki、import/upload、interwiki/*、managetags/activate、managetags/create、managetags/deactivate、managetags/delete、merge/merge、moderation/*、move/move、move/move_redir、namespaces/namespaces、namespaces/ns_add、namespaces/ns_delete、namespaces/ns_edit、newusers/autocreate、newusers/byemail、newusers/create、newusers/create2、newusers/newusers、patrol/autopatrol、patrol/patrol、protect/modify、protect/move_prot、protect/protect、protect/unprotect、renameuser/renameuser、rights/autopromote、rights/blockautopromote、rights/restoreautopromote、rights/rights、spamblacklist/*、suppress/block、suppress/delete、suppress/event、suppress/hide-afl、suppress/reblock、suppress/revision、suppress/unhide-afl、tag/update、titleblacklist/*、upload/overwrite、upload/revert、upload/upload
lestart

枚举的起始时间戳。

类型:时间戳(允许格式
leend

枚举的结束时间戳。

类型:时间戳(允许格式
ledir

列举的方向:

newer
最早的优先。注意:lestart应早于leend。
older
最新的优先(默认)。注意:lestart应晚于leend。
以下值中的一个:newer、older
默认:older
leuser

过滤记录为这些由指定用户做出的。

类型:通过 用户名、IP、跨wiki用户名(例如“前缀>示例用户”)和用户ID(例如“#12345”) 中任意一种方式指定的用户
letitle

过滤记录至这些与页面相关的。

lenamespace

过滤事件为在这些指定的命名空间中。

以下值中的一个:-1、-2、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
leprefix

过滤以此前缀开头的记录。

letag

只列举带此标签的事件日志记录。

lelimit

返回的事件日志记录总数。

类型:整数或max
值必须介于1和500之间。
默认:10
lecontinue

当更多结果可用时,使用这个继续。

例子:
列出最近日志事件。
api.php?action=query&list=logevents [在沙盒中打开]

list=mystashedfiles (msf)

获取当前用户上传暂存库中的文件列表。

参数:
msfprop

要检索文件的属性。

size
检索文件大小和图片尺寸。
type
检索文件的MIME类型和媒体类型。
值(以|替代物分隔):size、type
默认:(空)
msflimit

要获取文件的数量。

类型:整数或max
值必须介于1和500之间。
默认:10
msfcontinue

当更多结果可用时,使用这个继续。

例子:
获取当前用户上传暂存库中的文件的filekey、大小和像素尺寸。
api.php?action=query&list=mystashedfiles&msfprop=size [在沙盒中打开]

list=pagepropnames (ppn)

列出wiki中所有使用中的页面属性名称。

参数:
ppncontinue

当更多结果可用时,使用这个继续。

ppnlimit

返回名称的最大数量。

类型:整数或max
值必须介于1和500之间。
默认:10

list=pageswithprop (pwp)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

列出所有使用指定页面属性的页面。

参数:
pwppropname

要用于列举页面的页面属性(action=query&list=pagepropnames返回正在使用中的页面属性名称)。

这个参数是必须的。
pwpprop

要包含的信息束:

ids
添加页面ID。
title
添加页面的标题和命名空间ID。
value
添加页面属性值。
值(以|替代物分隔):ids、title、value
默认:ids|title
pwpcontinue

当更多结果可用时,使用这个继续。

pwplimit

返回页面的最大数量。

类型:整数或max
值必须介于1和500之间。
默认:10
pwpdir

排序的方向。

以下值中的一个:ascending、descending
默认:ascending

list=prefixsearch (ps)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

为页面标题执行前缀搜索。

尽管名称类似,但此模块不等于Special:PrefixIndex;详见action=query&list=allpages中的apprefix参数。此模块的目的类似action=opensearch:基于用户的输入提供最佳匹配的标题。取决于搜索引擎后端,这可能包括错拼纠正、避免重定向和其他启发性行为。

参数:
pssearch

搜索字符串。

这个参数是必须的。
psnamespace

搜索的命名空间。如果pssearch以有效命名空间前缀开头则忽略。

值(以|替代物分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
要指定所有值,请使用*
默认:0
pslimit

要返回的结果最大数。

类型:整数或max
值必须介于1和500之间。
默认:10
psoffset

当更多结果可用时,使用这个继续。

类型:整数
默认:0
例子:
搜索以meaning开头的页面标题。
api.php?action=query&list=prefixsearch&pssearch=meaning [在沙盒中打开]

list=protectedtitles (pt)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

列出所有被限制创建的标题。

参数:
ptnamespace

只列出这些命名空间的标题。

值(以|替代物分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
要指定所有值,请使用*
ptlevel

只列出带这些保护级别的标题。

值(以|替代物分隔):autoconfirmed、sysop
ptlimit

返回的总计页面数。

类型:整数或max
值必须介于1和500之间。
默认:10
ptdir

列举的方向:

newer
最早的优先。注意:ptstart应早于ptend。
older
最新的优先(默认)。注意:ptstart应晚于ptend。
以下值中的一个:newer、older
默认:older
ptstart

从此保护时间戳开始列举。

类型:时间戳(允许格式
ptend

列举至此保护时间戳为止。

类型:时间戳(允许格式
ptprop

要获取的属性:

timestamp
添加保护被添加时的时间戳。
user
添加对页面添加保护的用户。
userid
添加对页面添加保护的用户ID。
comment
为保护添加摘要。
parsedcomment
为保护添加解析的摘要。
expiry
添加保护将被提升时的时间戳。
level
添加保护级别。
值(以|替代物分隔):comment、expiry、level、parsedcomment、timestamp、user、userid
默认:timestamp|level
ptcontinue

当更多结果可用时,使用这个继续。

list=querypage (qp)

main | query | querypage
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

获取由基于QueryPage的特殊页面提供的列表。

参数:
qppage

特殊页面的名称。注意其区分大小写。

这个参数是必须的。
以下值中的一个:Ancientpages、BrokenRedirects、Deadendpages、DoubleRedirects、Fewestrevisions、GadgetUsage、ListDuplicatedFiles、Listredirects、Lonelypages、Longpages、MediaStatistics、Moderation、Mostcategories、Mostimages、Mostinterwikis、Mostlinked、Mostlinkedcategories、Mostlinkedtemplates、Mostrevisions、Shortpages、Uncategorizedcategories、Uncategorizedimages、Uncategorizedpages、Uncategorizedtemplates、Unusedcategories、Unusedimages、Unusedtemplates、Unwatchedpages、Wantedcategories、Wantedfiles、Wantedpages、Wantedtemplates、Withoutinterwiki
qpoffset

当更多结果可用时,使用这个继续。

类型:整数
默认:0
qplimit

返回的结果数。

类型:整数或max
值必须介于1和500之间。
默认:10

list=random (rn)

main | query | random
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

获取随机页面集。

页面列举在一个固定序列中,只有起始点是随机的。这意味着如果Main Page是列表中第一个随机页面的话,List of fictional monkeys总是第二个,List of people on stamps of Vanuatu是第三个等。

参数:
rnnamespace

只返回这些命名空间的页面。

值(以|替代物分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
要指定所有值,请使用*
rnfilterredir

如何过滤重定向。

以下值中的一个:all、nonredirects、redirects
默认:nonredirects
rnredirect
已弃用。

请改用rnfilterredir=redirects

类型:布尔型 (详情)
rnlimit

限制返回多少随机页面。

类型:整数或max
值必须介于1和500之间。
默认:1
rncontinue

当更多结果可用时,使用这个继续。

例子:
从主命名空间返回两个随机页面。
api.php?action=query&list=random&rnnamespace=0&rnlimit=2 [在沙盒中打开]
返回有关来自主命名空间的两个随机页面的页面信息。
api.php?action=query&generator=random&grnnamespace=0&grnlimit=2&prop=info [在沙盒中打开]

list=recentchanges (rc)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

列举最近更改。

参数:
rcstart

枚举的起始时间戳。

类型:时间戳(允许格式
rcend

枚举的结束时间戳。

类型:时间戳(允许格式
rcdir

列举的方向:

newer
最早的优先。注意:rcstart应早于rcend。
older
最新的优先(默认)。注意:rcstart应晚于rcend。
以下值中的一个:newer、older
默认:older
rcnamespace

过滤更改为仅限这些命名空间。

值(以|替代物分隔):-1、-2、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
要指定所有值,请使用*
rcuser

只列出此用户的更改。

类型:通过 用户名、IP、跨wiki用户名(例如“前缀>示例用户”)和用户ID(例如“#12345”) 中任意一种方式指定的用户
rcexcludeuser

不要列出此用户的更改。

类型:通过 用户名、IP、跨wiki用户名(例如“前缀>示例用户”)和用户ID(例如“#12345”) 中任意一种方式指定的用户
rctag

只列出带此标签的更改。

rcprop

包含的额外信息束:

user
添加造成编辑的用户,并标出它们是否是IP。如果用户已被修订删除,userhidden 属性会被退回。
userid
为编辑添加用户ID责任。如果用户已被修订删除,userhidden 属性会被退回。
comment
为编辑添加摘要。如果评论已被修订删除,commenthidden 属性会被退回。
parsedcomment
为编辑添加已解析的注释。如果评论已被版本删除,将返回commenthidden属性。
flags
为编辑添加标记。
timestamp
添加编辑的时间戳。
title
添加编辑的页面标题。
ids
添加页面ID、最近更改ID和新旧修订的ID。
sizes
添加新旧页面长度(字节)。
redirect
如果页面是重定向的话,标记编辑。
patrolled
将可巡查编辑标记为已巡查或未巡查。
loginfo
添加日志信息(日志ID、日志类型等)至日志记录。
tags
列举条目的标签。
sha1
添加与修订关联的条目的内容校验和。如果内容已被版本删除,将返回sha1hidden属性。
值(以|替代物分隔):comment、flags、ids、loginfo、parsedcomment、patrolled、redirect、sha1、sizes、tags、timestamp、title、user、userid
默认:title|timestamp|ids
rcshow

只显示满足这些标准的项目。例如,要只查看由登录用户做出的小编辑,设置rcshow=minor|!anon。

值(以|替代物分隔):!anon、!autopatrolled、!bot、!minor、!patrolled、!redirect、anon、autopatrolled、bot、minor、patrolled、redirect、unpatrolled
rclimit

返回总计更新数。

类型:整数或max
值必须介于1和500之间。
默认:10
rctype

显示的更改类型。

值(以|替代物分隔):categorize、edit、external、log、new
默认:edit|new|log|categorize
rctoponly

只列举作为最新修订的更改。

类型:布尔型 (详情)
rctitle

过滤记录至这些与页面相关的。

rccontinue

当更多结果可用时,使用这个继续。

rcgeneraterevisions

当作为生成器使用时,生成修订ID而不是标题。不带关联修订ID的最近更改记录(例如大多数日志记录)将不会生成任何东西。

类型:布尔型 (详情)
rcslot

仅列出涉及命名插槽的更改。

以下值中的一个:main

list=search (sr)

main | query | search
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

执行一次全文本搜索。

参数:
srsearch

搜索所有匹配此值的页面标题或内容。根据wiki的搜索后端工具,您可以使用搜索字符串以调用特殊搜索功能。

这个参数是必须的。
srnamespace

只在这些命名空间搜索。

值(以|替代物分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
要指定所有值,请使用*
默认:0
srlimit

返回的总计页面数。

类型:整数或max
值必须介于1和500之间。
默认:10
sroffset

当更多结果可用时,使用这个继续。

类型:整数
默认:0
srqiprofile

查询要使用的独立描述(影响排序算法)。

classic
基于传入链接、一些模板、页面语言和新近程度的排名(模板/语言/新近程度可能不会在此wiki激活)。
classic_noboostlinks
基于一些模板、页面语言和新近程度的排名,当在此wiki激活时。
empty
完全基于查询相关特性的排名(仅用于调试)。
wsum_inclinks
基于传入链接的加权和
wsum_inclinks_pv
基于传入链接及每周页面浏览的加权和
popular_inclinks_pv
主要基于页面预览排名
popular_inclinks
主要基于链入链接数排名
engine_autoselect
让搜索引擎决定使用的最佳个人资料。
以下值中的一个:classic、classic_noboostlinks、empty、engine_autoselect、popular_inclinks、popular_inclinks_pv、wsum_inclinks、wsum_inclinks_pv
默认:engine_autoselect
srwhat

要执行的搜索类型。

以下值中的一个:nearmatch、text、title
srinfo

要返回的元数据。

值(以|替代物分隔):rewrittenquery、suggestion、totalhits
默认:totalhits|suggestion|rewrittenquery
srprop

要返回的属性:

size
添加页面大小,单位为字节。
wordcount
添加页面的字数。
timestamp
添加页面上次编辑时的时间戳。
snippet
添加已解析的页面片段。
titlesnippet
添加已解析的页面标题片段。
redirecttitle
添加匹配的重定向的标题。
redirectsnippet
添加被解析的重定向标题的片段。
sectiontitle
添加匹配章节的标题。
sectionsnippet
添加已解析的匹配章节标题片段。
isfilematch
添加布尔值,表明搜索是否匹配文件内容。
categorysnippet
添加已解析的匹配分类片段。
score
已弃用。已忽略。
hasrelated
已弃用。已忽略。
extensiondata
添加由扩展生成的额外数据。
值(以|替代物分隔):categorysnippet、extensiondata、isfilematch、redirectsnippet、redirecttitle、sectionsnippet、sectiontitle、size、snippet、timestamp、titlesnippet、wordcount、hasrelated、score
默认:size|wordcount|timestamp|snippet
srinterwiki

搜索结果中包含跨wiki结果,如果可用。

类型:布尔型 (详情)
srenablerewrites

启用内部查询重写。一些搜索后端可以重写查询到另一个被认为能提供更好结果的位置,例如纠正拼写错误。

类型:布尔型 (详情)
srsort

设置返回结果的排序。

以下值中的一个:create_timestamp_asc、create_timestamp_desc、incoming_links_asc、incoming_links_desc、just_match、last_edit_asc、last_edit_desc、none、random、relevance、user_random
默认:relevance

list=tags (tg)

main | query | tags

列出更改标签。

参数:
tgcontinue

当更多结果可用时,使用这个继续。

tglimit

列出标签的最大数量。

类型:整数或max
值必须介于1和500之间。
默认:10
tgprop

要获取的属性:

displayname
为标签添加系统消息。
description
为标签添加描述。
hitcount
已添加此标签的修订版本与日志数量。
defined
标识标签是否已定义。
source
获得标签来源,它可能包括用于扩展定义的标签的extension,以及用于可被用户手动应用的标签的manual
active
标签是否仍可被应用。
值(以|替代物分隔):active、defined、description、displayname、hitcount、source
默认:(空)

list=usercontribs (uc)

获取一位用户的所有编辑。

参数:
uclimit

返回贡献的最大数量。

类型:整数或max
值必须介于1和500之间。
默认:10
ucstart

返回的开始时间戳,即此时间戳之前的修订。

类型:时间戳(允许格式
ucend

要返回的结束时间戳,即此时间戳之后的修订。

类型:时间戳(允许格式
uccontinue

当更多结果可用时,使用这个继续。

ucuser

要检索贡献的用户。不能与ucuseridsucuserprefix一起使用。

类型:通过 用户名、IP和跨wiki用户名(例如“前缀>示例用户”) 中任意一种方式指定的用户列表
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
ucuserids

要检索贡献的用户ID。不能与ucuserucuserprefix一起使用。

类型:整数列表
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
ucuserprefix

取得所有用户名以这个值开头的用户的贡献。不能与ucuserucuserids一起使用。

ucdir

列举的方向:

newer
最早的优先。注意:ucstart应早于ucend。
older
最新的优先(默认)。注意:ucstart应晚于ucend。
以下值中的一个:newer、older
默认:older
ucnamespace

只列出这些命名空间的贡献。

值(以|替代物分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
要指定所有值,请使用*
ucprop

包含额外的信息束:

ids
添加页面ID和修订ID。
title
添加页面标题及其命名空间ID。
timestamp
添加编辑的时间戳。
comment
添加编辑摘要。如果摘要已被版本删除,将返回commenthidden属性。
parsedcomment
添加被解析的编辑摘要。如果摘要已被版本删除,将返回commenthidden属性。
size
添加编辑的新大小。
sizediff
添加与父编辑相比该编辑的大小变化。
flags
添加编辑标记。
patrolled
标记已巡查编辑。
tags
列举用于编辑的标签。
值(以|替代物分隔):comment、flags、ids、parsedcomment、patrolled、size、sizediff、tags、timestamp、title
默认:ids|title|timestamp|comment|size|flags
ucshow

只显示符合这些标准的项目,例如只显示不是小编辑的编辑:ucshow=!minor

如果ucshow=patrolleducshow=!patrolled被设定,早于$wgRCMaxAge(7776000秒)的修订不会被显示。

值(以|替代物分隔):!autopatrolled、!minor、!new、!patrolled、!top、autopatrolled、minor、new、patrolled、top
uctag

只列出被此标签标记的修订。

uctoponly
已弃用。

只列举作为最新修订的更改。

类型:布尔型 (详情)

list=users (us)

main | query | users

获取有关列出用户的信息。

参数:
usprop

要包含的信息束:

blockinfo
如果用户被封禁就标记,并注明是谁封禁,以何种原因封禁的。
groups
列举每位用户属于的所有组。
groupmemberships
列举明确分配给每位用户的用户组,包括每个用户组成员的过期时间。
implicitgroups
列举用户自动作为成员之一的所有组。
rights
列举每位用户拥有的所有权限。
editcount
添加用户的编辑计数。
registration
添加用户的注册时间戳。
emailable
当用户可以并希望通过Special:Emailuser接收电子邮件时标记。
gender
标记用户性别。返回“male”、“female”或“unknown”。
centralids
添加中心ID并为用户附加状态。
cancreate
表明是否可以为有效但尚未注册的用户名创建一个账户。
值(以|替代物分隔):blockinfo、cancreate、centralids、editcount、emailable、gender、groupmemberships、groups、implicitgroups、registration、rights
usattachedwiki

usprop=centralids一起使用,表明用户是否附加于此ID定义的wiki。

ususers

要获取信息的用户列表。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
ususerids

要获得信息的用户ID列表。

类型:整数列表
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。

list=watchlist (wl)

main | query | watchlist
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

在当前用户的监视列表中获取对页面的最近更改。

参数:
wlallrev

将同一页面的多个修订包含于指定的时间表内。

类型:布尔型 (详情)
wlstart

枚举的起始时间戳。

类型:时间戳(允许格式
wlend

枚举的结束时间戳。

类型:时间戳(允许格式
wlnamespace

过滤更改为仅限指定命名空间。

值(以|替代物分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
要指定所有值,请使用*
wluser

只列出此用户的更改。

类型:通过 用户名、IP、跨wiki用户名(例如“前缀>示例用户”)和用户ID(例如“#12345”) 中任意一种方式指定的用户
wlexcludeuser

不要列出此用户的更改。

类型:通过 用户名、IP、跨wiki用户名(例如“前缀>示例用户”)和用户ID(例如“#12345”) 中任意一种方式指定的用户
wldir

列举的方向:

newer
最早的优先。注意:wlstart应早于wlend。
older
最新的优先(默认)。注意:wlstart应晚于wlend。
以下值中的一个:newer、older
默认:older
wllimit

根据结果返回的结果总数。

类型:整数或max
值必须介于1和500之间。
默认:10
wlprop

要获取的额外属性:

ids
添加修订ID和页面ID。
title
添加页面标题。
flags
为编辑添加标记。
user
添加做出编辑的用户。如果用户已被版本删除,将返回userhidden属性。
userid
添加做出编辑的用户的ID。若用户已被删除修订,会返回一个userhidden属性。
comment
添加编辑摘要。若编辑摘要已被删除修订,会返回一个commenthidden属性。
parsedcomment
添加解析过的编辑摘要。若编辑摘要已被删除修订,会返回一个commenthidden属性。
timestamp
添加编辑时间戳。
patrol
将编辑标记为已巡查。
sizes
添加页面的旧有长度和新长度。
notificationtimestamp
添加最近被通知有关编辑的用户的时间戳。
loginfo
在适当位置添加日志信息。
tags
列举条目的标签。
expiry
(没有说明)
值(以|替代物分隔):comment、expiry、flags、ids、loginfo、notificationtimestamp、parsedcomment、patrol、sizes、tags、timestamp、title、user、userid
默认:ids|title|flags
wlshow

只显示满足这些标准的项目。例如,要只查看由登录用户做出的小编辑,设置wlshow=minor|!anon。

值(以|替代物分隔):!anon、!autopatrolled、!bot、!minor、!patrolled、!unread、anon、autopatrolled、bot、minor、patrolled、unread
wltype

要显示的更改类型:

edit
普通页面编辑。
new
页面创建。
log
日志记录。
external
外部更改。
categorize
分类成员组更改。
值(以|替代物分隔):categorize、edit、external、log、new
默认:edit|new|log|categorize
wlowner

与wltoken一起使用以访问不同用户的监视列表。

类型:通过 用户名 方式指定的用户
wltoken

允许访问其他用户监视列表的安全密钥(可通过用户的参数设置找到)。

wlcontinue

当更多结果可用时,使用这个继续。

例子:
在当前用户的监视列表中列出用于最近更改页面的最新修订。
api.php?action=query&list=watchlist [在沙盒中打开]
在当前用户的监视列表中检索有关用于最近更改页面的最新修订的额外信息。
api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment [在沙盒中打开]
获取有关当前用户监视列表中最近更改页面的最高修订的附加信息,包括临时监视的项目何时到期。
api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment|expiry [在沙盒中打开]
在当前用户的监视列表中检索有关所有最近对页面的更改的信息。
api.php?action=query&list=watchlist&wlallrev=&wlprop=ids|title|timestamp|user|comment [在沙盒中打开]
在当前用户的监视列表中检索用于最近更改页面的页面信息。
api.php?action=query&generator=watchlist&prop=info [在沙盒中打开]
在当前用户的监视列表中检索用于对页面最近更改的修订信息。
api.php?action=query&generator=watchlist&gwlallrev=&prop=revisions&rvprop=timestamp|user [在沙盒中打开]
在用户Example的监视列表中列出用于最近更改页面的最新修订。
api.php?action=query&list=watchlist&wlowner=Example&wltoken=123ABC [在沙盒中打开]

list=watchlistraw (wr)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

获得当前用户的监视列表上的所有页面。

参数:
wrcontinue

当更多结果可用时,使用这个继续。

wrnamespace

只列出指定命名空间的页面。

值(以|替代物分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、106、107、108、109、112、113、114、115、274、275、828、829、2300、2301、2302、2303、2600
要指定所有值,请使用*
wrlimit

根据结果返回的结果总数。

类型:整数或max
值必须介于1和500之间。
默认:10
wrprop

要获取的额外属性:

changed
添加最近被通知有关编辑的用户的时间戳。
值(以|替代物分隔):changed
wrshow

只列出符合这些标准的项目。

值(以|替代物分隔):!changed、changed
wrowner

与wrtoken一起使用以访问不同用户的监视列表。

类型:通过 用户名 方式指定的用户
wrtoken

允许访问其他用户监视列表的安全密钥(可通过用户的参数设置找到)。

wrdir

罗列所采用的方向。

以下值中的一个:ascending、descending
默认:ascending
wrfromtitle

要列举的起始标题(带命名空间前缀)。

wrtotitle

要列举的最终标题(带命名空间前缀)。

例子:
列出当前用户的监视列表中的页面。
api.php?action=query&list=watchlistraw [在沙盒中打开]
检索当前用户监视列表上的页面的页面信息。
api.php?action=query&generator=watchlistraw&gwrshow=changed&prop=info [在沙盒中打开]

meta=allmessages (am)

返回来自该网站的消息。

参数:
ammessages

要输出的消息。*(默认)表示所有消息。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
默认:*
amprop

要获取的属性。

值(以|替代物分隔):default
amenableparser

设置以启用解析器,将处理消息的wikitext(替代魔术字、处理模板等)。

类型:布尔型 (详情)
amnocontent

如果设置,不要在输出中包含消息内容。

类型:布尔型 (详情)
amincludelocal

也包括本地消息,也就是不存在于软件但存在于MediaWiki命名空间的消息。 这会列举所有MediaWiki命名空间页面,因此它也将列举那些不是真消息的消息,例如Common.js

类型:布尔型 (详情)
amargs

要替代进消息的参数。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
amfilter

只返回名称包含此字符串的消息。

amcustomised

只返回在此定制情形下的消息。

以下值中的一个:all、modified、unmodified
默认:all
amlang

返回这种语言的信息。

amfrom

从此消息开始返回消息。

amto

返回消息至此消息为止。

amtitle

当解析消息时,要用作环境的页面(用于amenableparser选项)。

amprefix

返回带有该前缀的消息。

meta=authmanagerinfo (ami)

检索有关当前身份验证状态的信息。

参数:
amisecuritysensitiveoperation

测试用户当前的身份验证状态是否足够用于指定的安全敏感操作。

amirequestsfor

取得指定身份验证操作所需的有关身份验证请求的信息。

以下值中的一个:change、create、create-continue、link、link-continue、login、login-continue、remove、unlink
amimergerequestfields

合并用于所有身份验证请求的字段信息至一个数组中。

类型:布尔型 (详情)
amimessageformat

用于返回消息的格式。

以下值中的一个:html、none、raw、wikitext
默认:wikitext

meta=filerepoinfo (fri)

返回有关wiki配置的图片存储库的元信息。

参数:
friprop

要获取的存储库属性(可用属性在其他wiki上可能不同)。

canUpload
文件是否可以上传至此存储库,例如通过CORS和共享身份验证。
displayname
人类可读的存储库wiki名称。
favicon
存储库wiki的网站图标URL,来自$wgFavicon
initialCapital
文件名是否隐式地以大写字母开头。
local
存储库是否为本地的。
name
存储库的关键词 - 用于例如$wgForeignFileReposimageinfo返回的值。
rootUrl
用于图片路径的根URL路径。
scriptDirUrl
用于存储库wiki的MediaWiki安装副本的根URL路径。
thumbUrl
用于缩略图路径的根URL路径。
url
公开区域URL路径。
值(以|替代物分隔):canUpload、displayname、favicon、initialCapital、local、name、rootUrl、scriptDirUrl、thumbUrl、url
默认:canUpload|displayname|favicon|initialCapital|local|name|rootUrl|scriptDirUrl|thumbUrl|url

meta=languageinfo (li)

返回有关可用语言的信息。

Continuation may be applied if retrieving the information takes too long for one request.

参数:
liprop

获取每种语言的信息。

code
语言代码。(此代码是特定于MediaWiki的,但与其他标准有重叠。)
bcp47
BCP-47语言代码。
dir
语言的书写方向(ltrrtl)。
autonym
语言的自称,即在该语言中的名称。
name
uselang参数指定语言中的语言名称,必要时应用语言回退。
fallbacks
为此语言配置的后备语言的语言代码。 不包括对 'en' 的隐式最终回退(但某些语言可能会明确回退到 'en')。
variants
此语言所支持的变体的语言代码。
值(以|替代物分隔):autonym、bcp47、code、dir、fallbacks、name、variants
默认:code
licode

应返回的语言的语言代码,或所有语言*

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
默认:*
licontinue

当更多结果可用时,使用这个继续。

例子:
获取所有支持语言的语言代码。
api.php?action=query&meta=languageinfo [在沙盒中打开]
Get the autonyms and German names of all supported languages.
api.php?action=query&meta=languageinfo&liprop=autonym|name&uselang=de [在沙盒中打开]
Get the fallback languages and variants of Occitan.
api.php?action=query&meta=languageinfo&liprop=fallbacks|variants&licode=oc [在沙盒中打开]
获取所有支持语言的BCP-47语言代码和书写方向。
api.php?action=query&meta=languageinfo&liprop=bcp47|dir [在沙盒中打开]

meta=notifications (not)

  • 此模块需要读取权限。
  • 来源:Echo
  • 许可协议:MIT

获取当前用户等待的通知。

参数:
notfilter

过滤返回的通知。

值(以|替代物分隔):!read、read
默认:read|!read
notprop

请求的细节。

值(以|替代物分隔):count、list、seenTime
默认:list
notsections

要查询的通知部分(也就是说“alert”和“message”的一些结合)。

值(以|替代物分隔):alert、message
默认:alert|message
notgroupbysection

是否按章节分组结果。如果设置,将分别获取每个章节。

类型:布尔型 (详情)
notformat

如果指定,通知将以此格式返回。

model
原始通知数据
special
格式化用于Special:Notifications页面(并仅限于此!)不要依赖HTML,这可能在任何指定的时间更改。
flyout
已弃用。使用notformat=model用于原始数据
html
已弃用。使用notformat=model用于原始数据
以下值中的一个:flyout、html、model、special
notlimit

返回通知的最大数量。

类型:整数或max
值必须介于1和50之间。
默认:20
notcontinue

当更多结果可用时,使用这个继续。

notunreadfirst

是否首先显示未读通知(只当groupbysection未设置时使用)。

类型:布尔型 (详情)
nottitles

只返回这些页面的通知。要获取未分配给任何页面的通知,使用[]作为标题。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
notbundle

是否根据通知类型捆绑规则,显示兼容捆绑的未读通知。

类型:布尔型 (详情)
notnotifiertypes

Notifier types for which to return notifications.

值(以|替代物分隔):email、web
默认:web
notalertcontinue

当更多提醒结果可用时,使用这个继续。

notalertunreadfirst

是否首先显示未读的消息通知(只当groupbysection已设置时使用)。

类型:布尔型 (详情)
notmessagecontinue

当更多消息结果可用时,使用这个继续。

notmessageunreadfirst

是否首先显示未读的提醒通知(只当groupbysection已设置时使用)。

类型:布尔型 (详情)

meta=siteinfo (si)

main | query | siteinfo

返回有关网站的一般信息。

参数:
siprop

要获取的信息:

general
全部系统信息。
namespaces
注册的命名空间及其规范名称列表。
namespacealiases
注册的命名空间别名列表。
specialpagealiases
特殊页面别名列表。
magicwords
魔术字及其别名列表。
interwikimap
返回跨wiki映射(可选过滤,可选择使用siinlanguagecode本地化)。
dbrepllag
返回数据库服务器与最高反应延迟。
statistics
返回网站统计。
usergroups
返回用户组及其相关权限。
libraries
返回wiki上安装的库。
extensions
返回wiki上安装的扩展。
fileextensions
返回允许上传的文件扩展名(文件类型)列表。
rightsinfo
当可用时返回wiki的版权(许可协议)信息。
restrictions
返回可用的编辑限制(保护)类型信息。
languages
返回MediaWiki支持的语言列表(可选择使用siinlanguagecode本地化)。
languagevariants
当启用了语言转换器,并且每个语言变体都受支持时,返回语言代码列表。
skins
返回所有启用的皮肤列表(可选择使用siinlanguagecode本地化,否则是内容语言)。
extensiontags
返回解析器扩展标签列表。
functionhooks
返回解析器函数钩列表。
showhooks
返回所有订阅的钩列表($wgHooks的内容)。
variables
返回变量ID列表。
protocols
返回外部链接中允许的协议列表。
defaultoptions
返回用户设置的默认值。
uploaddialog
返回上传对话框的配置。
值(以|替代物分隔):dbrepllag、defaultoptions、extensions、extensiontags、fileextensions、functionhooks、general、interwikimap、languages、languagevariants、libraries、magicwords、namespacealiases、namespaces、protocols、restrictions、rightsinfo、showhooks、skins、specialpagealiases、statistics、uploaddialog、usergroups、variables
默认:general
sifilteriw

只返回跨wiki地图中的本地或非本地记录。

以下值中的一个:!local、local
sishowalldb

列出所有数据库服务器,不只是最落后的那个。

类型:布尔型 (详情)
sinumberingroup

列出用户组中的用户数。

类型:布尔型 (详情)
siinlanguagecode

用于本地化语言名称(尽可能)和皮肤名称的语言代码。

meta=tokens

main | query | tokens

获取可修改数据的操作的令牌。

参数:
type

要请求的令牌类型。

值(以|替代物分隔):createaccount、csrf、login、patrol、rollback、userrights、watch
默认:csrf
例子:
检索一个csrf令牌(默认)。
api.php?action=query&meta=tokens [在沙盒中打开]
检索一个监视令牌和一个巡查令牌。
api.php?action=query&meta=tokens&type=watch|patrol [在沙盒中打开]

meta=unreadnotificationpages (unp)

  • 此模块需要读取权限。
  • 来源:Echo
  • 许可协议:MIT

获取当前用户未读通知的相关页面。

参数:
unpgrouppages

将讨论页与它们的主题页面一起分组,并将未分配给某一页面的通知与当前用户的用户页一起分组。

类型:布尔型 (详情)
unplimit

返回页面的最大数量。

类型:整数或max
值必须介于1和2,000之间。
默认:10
例子:
列举有(对应数量)未读通知的页面
api.php?action=query&meta=unreadnotificationpages [在沙盒中打开]

meta=userinfo (ui)

main | query | userinfo

获取有关当前用户的信息。

参数:
uiprop

要包含的信息束:

blockinfo
如果当前用户被封禁就标记,并注明是谁封禁,以何种原因封禁的。
hasmsg
如果当前用户有等待中的消息的话,添加标签messages
groups
列举当前用户隶属的所有群组。
groupmemberships
列举明确分配给当前用户的用户组,包括每个用户组成员的过期时间。
implicitgroups
列举当前用户的所有自动成为成员的用户组。
rights
列举当前用户拥有的所有权限。
changeablegroups
列举当前用户可以添加并移除的用户组。
options
列举当前用户设置的所有参数设置。
editcount
添加当前用户的编辑计数。
ratelimits
列举所有应用到当前用户的速率限制。
theoreticalratelimits
列出所有适用于当前用户的速率限制,前提是他们不能基于用户权限或ip免除所有速率限制
email
添加用户的电子邮件地址及电子邮件验证日期。
realname
添加用户的真实姓名。
acceptlang
重复由客户端以结构化格式发送的Accept-Language标头。
registrationdate
添加用户的注册时间。
unreadcount
添加用户监视列表上的未读页面数量(最多999;如有更多则返回1000+)。
centralids
添加中心ID并为用户附加状态。
latestcontrib
添加用户最新贡献的日期。
值(以|替代物分隔):acceptlang、blockinfo、centralids、changeablegroups、editcount、email、groupmemberships、groups、hasmsg、implicitgroups、latestcontrib、options、ratelimits、realname、registrationdate、rights、theoreticalratelimits、unreadcount
要指定所有值,请使用*
uiattachedwiki

uiprop=centralids一起使用,表明用户是否附加于此ID定义的wiki。

action=removeauthenticationdata

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

从当前用户移除身份验证数据。

参数:
request

使用此身份验证请求,通过返回自action=query&meta=authmanagerinfoidamirequestsfor=remove

这个参数是必须的。
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。
例子:
尝试移除当前用户的FooAuthenticationRequest数据。
api.php?action=removeauthenticationdata&request=FooAuthenticationRequest&token=123ABC [在沙盒中打开]

action=resetpassword

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

向用户发送密码重置邮件。

参数:
user

正在重置的用户。

类型:通过 用户名 方式指定的用户
email

正在重置用户的电子邮件地址。

token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。
例子:
向用户Example发送密码重置邮件。
api.php?action=resetpassword&user=Example&token=123ABC [在沙盒中打开]
向所有电子邮件地址为user@example.com的用户发送密码重置邮件。
api.php?action=resetpassword&user=user@example.com&token=123ABC [在沙盒中打开]

action=revisiondelete

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

删除和恢复修订版本。

参数:
type

正在执行的修订版本删除类型。

这个参数是必须的。
以下值中的一个:archive、filearchive、logging、oldimage、revision
target

要进行修订版本删除的页面标题,如果对某一类型需要。

ids

用于将被删除的修订的标识符。

这个参数是必须的。
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
hide

每次修订要隐藏的东西。

值(以|替代物分隔):comment、content、user
show

每次修订要恢复显示的东西。

值(以|替代物分隔):comment、content、user
suppress

是否对管理员及其他人禁止数据。

以下值中的一个:no、nochange、yes
默认:nochange
reason

删除或恢复的原因。

tags

要在删除日志中应用到实体的标签。

值(以|替代物分隔):
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=rollback

main | rollback
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

撤销对页面的最近编辑。

如果上一对页面做出编辑的用户连续做出了多次编辑,它们将全数被回退。

参数:
title

要回退的页面标题。不能与pageid一起使用。

pageid

要回退的页面的页面 ID。不能与title一起使用。

类型:整数
tags

要应用在回退上的标签。

值(以|替代物分隔):
user

做出要回退的编辑的用户名称。

这个参数是必须的。
类型:通过 用户名、IP、跨wiki用户名(例如“前缀>示例用户”)和用户ID(例如“#12345”) 中任意一种方式指定的用户
summary

自定义编辑摘要。如果为空,将使用默认摘要。

默认:(空)
markbot

将被回退的编辑和回退操作标记为机器人编辑。

类型:布尔型 (详情)
watchlist

无条件地将页面加入至当前用户的监视列表或将其移除(忽略机器人用户),使用设置或不更改监视。

以下值中的一个:nochange、preferences、unwatch、watch
默认:preferences
token

action=query&meta=tokens取回的“rollback”令牌

出于兼容性考虑,web UI中使用的令牌也被接受。

这个参数是必须的。
例子:
回退由用户ExampleMain Page做出的最近编辑。
api.php?action=rollback&title=Main%20Page&user=Example&token=123ABC [在沙盒中打开]
回退由IP用户192.0.2.5对页面Main Page做出的最近编辑,带编辑摘要Reverting vandalism,并将这些编辑和回退标记为机器人编辑。
api.php?action=rollback&title=Main%20Page&user=192.0.2.5&token=123ABC&summary=Reverting%20vandalism&markbot=1 [在沙盒中打开]

action=rsd

main | rsd

导出一个RSD(Really Simple Discovery)架构。

例子:
导出RSD架构。
api.php?action=rsd [在沙盒中打开]

action=scribunto-console

  • 此模块是内部或不稳定的。它的操作可以更改而不另行通知。
  • 此模块需要读取权限。
  • 来源:Scribunto
  • 许可协议:GPL-2.0-or-later AND MIT

从Scribunto控制台提供XHR请求的内部模块。

参数:
title

要测试的模块的标题。

content

模块的新内容。

session

会话令牌。

类型:整数
question

要作为脚本评估的下一行。

这个参数是必须的。
clear

设置以清除当前的会话状态。

类型:布尔型 (详情)

action=setnotificationtimestamp

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

更新监视页面的通知时间戳。

这会影响监视列表和历史中已更改页面的高亮度,并且如果“当我的监视列表中的页面或文件发生更改时发送电子邮件通知我”设置被启用的话,也会影响电子邮件的发送。

参数:
entirewatchlist

工作于所有已监视页面。

类型:布尔型 (详情)
timestamp

要设置通知时间戳的时间戳。

类型:时间戳(允许格式
torevid

要设置通知时间戳的修订(只限一个页面)。

类型:整数
newerthanrevid

要设置通知时间戳的较新修订(只限一个页面)。

类型:整数
continue

当更多结果可用时,使用这个继续。

titles

要工作的标题列表。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
pageids

要工作的页面ID列表。

类型:整数列表
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
revids

要工作的修订ID列表。

类型:整数列表
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
generator

通过执行指定查询模块获得页面列表以工作。

注意:发生器参数名称必须以“g”开头,参见例子。

allcategories
列举所有分类。
alldeletedrevisions
列举由一位用户或在一个命名空间中所有已删除的修订。
allfileusages
列出所有文件用途,包括不存在的。
allimages
按顺序枚举所有图像。
alllinks
列举所有指向至指定命名空间的链接。
allpages
循序列举在指定命名空间中的所有页面。
allredirects
列出至一个命名空间的重定向。
allrevisions
列举所有修订。
alltransclusions
列出所有嵌入页面(使用{{x}}嵌入的页面),包括不存在的。
backlinks
查找所有链接至指定页面的页面。
categories
页面属于的所有分类列表。
categorymembers
在指定的分类中列出所有页面。
deletedrevisions
获取删除的修订版本信息。
duplicatefiles
根据哈希值列出此给定文件的所有副本。
embeddedin
查找所有嵌入指定标题的页面。
exturlusage
列举包含一个指定URL的页面。
fileusage
查找所有使用指定文件的页面。
images
返回指定页面上包含的所有文件。
imageusage
查找所有使用指定图片标题的页面。
iwbacklinks
查找所有链接至指定跨wiki链接的页面。
langbacklinks
查找所有链接至指定语言链接的页面。
links
从指定页面返回所有链接。
linkshere
查找所有链接至指定页面的页面。
pageswithprop
列出所有使用指定页面属性的页面。
prefixsearch
为页面标题执行前缀搜索。
protectedtitles
列出所有被限制创建的标题。
querypage
获取由基于QueryPage的特殊页面提供的列表。
random
获取随机页面集。
recentchanges
列举最近更改。
redirects
返回至指定页面的所有重定向。
revisions
获取修订版本信息。
search
执行一次全文本搜索。
templates
返回指定页面上所有被嵌入的页面。
transcludedin
查找所有嵌入指定页面的页面。
watchlist
在当前用户的监视列表中获取对页面的最近更改。
watchlistraw
获得当前用户的监视列表上的所有页面。
以下值中的一个:allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

自动解决在titlespageidsrevids,以及在由generator返回的页面中的重定向。

类型:布尔型 (详情)
converttitles

如有需要,将标题转换为其他变体。只有当wiki的内容语言支持变体转换时才能工作。支持变体转换的语言包括ban、en、crh、gan、iu、kk、ku、shi、sr、tg、uz和zh。

类型:布尔型 (详情)
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=setpagelanguage

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

更改页面的语言。

此wiki不允许更改页面的语言。

启用$wgPageLanguageUseDB以使用此操作。

参数:
title

您希望更改语言的页面标题。不能与pageid一起使用。

pageid

您希望更改语言的页面ID。不能与title一起使用。

类型:整数
lang

更改页面的目标语言的语言代码。使用default以重置页面为wiki的默认内容语言。

这个参数是必须的。
以下值中的一个:ab、abs、ace、ady、ady-cyrl、aeb、aeb-arab、aeb-latn、af、ak、aln、alt、am、ami、an、ang、anp、ar、arc、arn、arq、ary、arz、as、ase、ast、atj、av、avk、awa、ay、az、azb、ba、ban、ban-bali、bar、bbc、bbc-latn、bcc、bci、bcl、be、be-tarask、bg、bgn、bh、bho、bi、bjn、bm、bn、bo、bpy、bqi、br、brh、bs、btm、bto、bug、bxr、ca、cbk-zam、cdo、ce、ceb、ch、chr、chy、ckb、co、cps、cr、crh、crh-cyrl、crh-latn、cs、csb、cu、cv、cy、da、dag、de、de-at、de-ch、de-formal、default、din、diq、dsb、dtp、dty、dv、dz、ee、egl、el、eml、en、en-ca、en-gb、eo、es、es-formal、et、eu、ext、fa、ff、fi、fit、fj、fo、fr、frc、frp、frr、fur、fy、ga、gag、gan、gan-hans、gan-hant、gcr、gd、gl、glk、gn、gom、gom-deva、gom-latn、gor、got、grc、gsw、gu、guc、guw、gv、ha、hak、haw、he、hi、hif、hif-latn、hil、hr、hrx、hsb、ht、hu、hu-formal、hy、hyw、ia、id、ie、ig、ii、ik、ike-cans、ike-latn、ilo、inh、io、is、it、iu、ja、jam、jbo、jut、jv、ka、kaa、kab、kbd、kbd-cyrl、kbp、kcg、kg、khw、ki、kiu、kjp、kk、kk-arab、kk-cn、kk-cyrl、kk-kz、kk-latn、kk-tr、kl、km、kn、ko、ko-kp、koi、krc、kri、krj、krl、ks、ks-arab、ks-deva、ksh、ku、ku-arab、ku-latn、kum、kv、kw、ky、la、lad、lb、lbe、lez、lfn、lg、li、lij、liv、lki、lld、lmo、ln、lo、loz、lrc、lt、ltg、lus、luz、lv、lzh、lzz、mad、mai、map-bms、mdf、mg、mhr、mi、min、mk、ml、mn、mni、mnw、mo、mr、mrh、mrj、ms、ms-arab、mt、mwl、my、myv、mzn、na、nah、nan、nap、nb、nds、nds-nl、ne、new、nia、niu、nl、nl-informal、nn、nov、nqo、nrm、nso、nv、ny、nys、oc、ojb、olo、om、or、os、pa、pag、pam、pap、pcd、pdc、pdt、pfl、pi、pih、pl、pms、pnb、pnt、prg、ps、pt、pt-br、pwn、qu、qug、rgn、rif、rm、rmc、rmy、ro、roa-tara、ru、rue、rup、ruq、ruq-cyrl、ruq-latn、rw、sa、sah、sat、sc、scn、sco、sd、sdc、sdh、se、sei、ses、sg、sgs、sh、shi、shn、shy、shy-latn、si、sjd、sje、sk、skr、skr-arab、sl、sli、sm、sma、smn、sn、so、sq、sr、sr-ec、sr-el、srn、ss、st、stq、sty、su、sv、sw、szl、szy、ta、tay、tcy、te、tet、tg、tg-cyrl、tg-latn、th、ti、tk、tl、tly、tn、to、tpi、tr、tru、trv、ts、tt、tt-cyrl、tt-latn、tw、ty、tyv、tzm、udm、ug、ug-arab、ug-latn、uk、ur、uz、ve、vec、vep、vi、vls、vmf、vo、vot、vro、wa、war、wls、wo、wuu、xal、xh、xmf、xsy、yi、yo、yue、za、zea、zgh、zh、zh-cn、zh-hans、zh-hant、zh-hk、zh-mo、zh-my、zh-sg、zh-tw、zu
reason

更改原因。

tags

要应用到此操作导致的日志记录的更改标签。

值(以|替代物分隔):
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=smwbrowse

main | smwbrowse
  • 此模块需要读取权限。
  • 来源:Semantic MediaWiki
  • 许可协议:GPL-2.0-or-later

对不同的实体类型支持浏览与搜索活动的Semantic MediaWiki API模块。

参数:
browse
⧼apihelp-smwbrowse-param-browse⧽
这个参数是必须的。
以下值中的一个:category、concept、page、property、psubject、pvalue、subject
params
⧼apihelp-smwbrowse-param-params⧽
这个参数是必须的。

action=smwinfo

main | smwinfo
  • 此模块需要读取权限。
  • 来源:Semantic MediaWiki
  • 许可协议:GPL-2.0-or-later

检索有关语义MediaWiki统计信息及其他元信息的API模块。

参数:
info
⧼apihelp-smwinfo-param-info⧽
值(以|替代物分隔):conceptcount、declaredpropcount、deletecount、errorcount、formatcount、jobcount、propcount、proppagecount、querycount、querysize、subobjectcount、totalpropcount、usedpropcount
默认:propcount|usedpropcount|declaredpropcount

action=smwtask

main | smwtask
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:Semantic MediaWiki
  • 许可协议:GPL-2.0-or-later

执行语义MediaWiki相关任务的API模块(仅内部使用,不公开)。

参数:
task

Defines the task type

这个参数是必须的。
以下值中的一个:check-query、duplicate-lookup、insert-job、run-entity-examiner、run-joblist、table-statistics、update
params

JSON encoded parameters that match the selected task type requirement

token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。
例子:
Example of running a update task for a particular subject:
api.php?action=smwtask&task=update&params={ "subject": "Foo" } [在沙盒中打开]

action=spamblacklist

  • 此模块需要读取权限。
  • 来源:SpamBlacklist
  • 许可协议:GPL-2.0-or-later

验证一个或多个URL是否触发垃圾链接黑名单。

参数:
url

要验证是否触发黑名单的URL。

这个参数是必须的。
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。

action=stashedit

main | stashedit
  • 此模块是内部或不稳定的。它的操作可以更改而不另行通知。
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

在分享缓存中准备编辑。

这是打算通过使用来自编辑表单的AJAX以改进页面保存的性能。

参数:
title

已开始编辑的页面标题。

这个参数是必须的。
section

段落数。0用于首段,new用于新的段落。

sectiontitle

新段落的标题。

text

页面内容。

stashedtexthash

要使用的来自先前暂存处的页面内容哈希。

summary

更改摘要。

默认:(空)
contentmodel

新内容的内容模型。

这个参数是必须的。
以下值中的一个:GadgetDefinition、Scribunto、css、javascript、json、smw/schema、text、unknown、wikitext
contentformat

用于输入文本的内容序列化格式。

这个参数是必须的。
以下值中的一个:application/json、application/octet-stream、application/unknown、application/x-binary、text/css、text/javascript、text/plain、text/unknown、text/x-wiki、unknown/unknown
baserevid

基础修订的修订ID。

这个参数是必须的。
类型:整数
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=tag

main | tag
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

从个别修订或日志记录中添加或移除更改标签。

参数:
rcid

要添加或移除标签的一个或更多的最近更改ID。

类型:整数列表
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
revid

要添加或移除标签的一个或更多的修订ID。

类型:整数列表
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
logid

要添加或移除标签的一个或更多的日志记录ID。

类型:整数列表
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
add

要添加的标签。只有手动定义的标签可以添加。

值(以|替代物分隔):
remove

要移除的标签。只有手动定义或完全不明确的标签可以被移除。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
reason

更改原因。

默认:(空)
tags

要应用到将被创建为此操作结果的日志实体的标签。

值(以|替代物分隔):
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。
例子:
vandalism标签添加至修订ID 123,而不指定原因
api.php?action=tag&revid=123&add=vandalism&token=123ABC [在沙盒中打开]
从日志记录ID 123移除spam标签,原因为Wrongly applied
api.php?action=tag&logid=123&remove=spam&reason=Wrongly+applied&token=123ABC [在沙盒中打开]

action=templatedata

  • 此模块需要读取权限。
  • 来源:TemplateData
  • 许可协议:GPL-2.0-or-later

获取由模板数据扩展存储的数据。

参数:
includeMissingTitles

返回有关标题的数据,即便其丢失或缺少模板数据。默认情况下只在标题存在且有模板数据时返回标题。

类型:布尔型 (详情)
doNotIgnoreMissingTitles
已弃用。

返回有关标题的数据,即便其丢失或缺少模板数据。默认情况下(出于向后兼容性)只在标题存在且有模板数据时返回标题。

类型:布尔型 (详情)
lang

返回此语言的本地化值。默认会返回所有可用翻译。

titles

要工作的标题列表。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
pageids

要工作的页面ID列表。

类型:整数列表
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
revids

要工作的修订ID列表。

类型:整数列表
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
generator

通过执行指定查询模块获得页面列表以工作。

注意:发生器参数名称必须以“g”开头,参见例子。

allcategories
列举所有分类。
alldeletedrevisions
列举由一位用户或在一个命名空间中所有已删除的修订。
allfileusages
列出所有文件用途,包括不存在的。
allimages
按顺序枚举所有图像。
alllinks
列举所有指向至指定命名空间的链接。
allpages
循序列举在指定命名空间中的所有页面。
allredirects
列出至一个命名空间的重定向。
allrevisions
列举所有修订。
alltransclusions
列出所有嵌入页面(使用{{x}}嵌入的页面),包括不存在的。
backlinks
查找所有链接至指定页面的页面。
categories
页面属于的所有分类列表。
categorymembers
在指定的分类中列出所有页面。
deletedrevisions
获取删除的修订版本信息。
duplicatefiles
根据哈希值列出此给定文件的所有副本。
embeddedin
查找所有嵌入指定标题的页面。
exturlusage
列举包含一个指定URL的页面。
fileusage
查找所有使用指定文件的页面。
images
返回指定页面上包含的所有文件。
imageusage
查找所有使用指定图片标题的页面。
iwbacklinks
查找所有链接至指定跨wiki链接的页面。
langbacklinks
查找所有链接至指定语言链接的页面。
links
从指定页面返回所有链接。
linkshere
查找所有链接至指定页面的页面。
pageswithprop
列出所有使用指定页面属性的页面。
prefixsearch
为页面标题执行前缀搜索。
protectedtitles
列出所有被限制创建的标题。
querypage
获取由基于QueryPage的特殊页面提供的列表。
random
获取随机页面集。
recentchanges
列举最近更改。
redirects
返回至指定页面的所有重定向。
revisions
获取修订版本信息。
search
执行一次全文本搜索。
templates
返回指定页面上所有被嵌入的页面。
transcludedin
查找所有嵌入指定页面的页面。
watchlist
在当前用户的监视列表中获取对页面的最近更改。
watchlistraw
获得当前用户的监视列表上的所有页面。
以下值中的一个:allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

自动解决在titlespageidsrevids,以及在由generator返回的页面中的重定向。

类型:布尔型 (详情)
converttitles

如有需要,将标题转换为其他变体。只有当wiki的内容语言支持变体转换时才能工作。支持变体转换的语言包括ban、en、crh、gan、iu、kk、ku、shi、sr、tg、uz和zh。

类型:布尔型 (详情)
例子:
返回Template:StubTemplate:Example的模板数据,如果模板不存在,或虽然存在但没有模板数据的话就返回结果
api.php?action=templatedata&titles=Template:Stub|Template:Example&includeMissingTitles=1 [在沙盒中打开]
返回Template:StubTemplate:Example的模板数据,如果模板不存在,或虽然存在但没有模板数据的话就不返回结果
api.php?action=templatedata&titles=Template:Stub|Template:Example [在沙盒中打开]

action=titleblacklist (tb)

  • 此模块需要读取权限。
  • 来源:TitleBlacklist
  • 许可协议:GPL-2.0-or-later

验证一个页面的标题、文件名或用户名是否触发标题黑名单。

参数:
tbtitle

验证是否触发黑名单的字符串。

这个参数是必须的。
tbaction

要检查的操作。

以下值中的一个:create、createpage、createtalk、edit、move、new-account、upload
默认:edit
tbnooverride

不要尝试绕开标题黑名单。

类型:布尔型 (详情)

action=unblock

main | unblock
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

解封一位用户。

参数:
id

解封时需要的封禁ID(通过list=blocks获得)。不能与user一起使用。

类型:整数
user

要解封的用户。不能与id一起使用。

类型:通过 用户名、IP、IP范围和用户ID(例如“#12345”) 中任意一种方式指定的用户
userid
已弃用。

改成指定user=#ID

类型:整数
reason

解封的原因。

默认:(空)
tags

要在封禁日志中应用到实体的更改标签。

值(以|替代物分隔):
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=undelete

main | undelete
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

恢复删除页面的修订版本。

被删除修订的列表(包括时间戳)可通过prop=deletedrevisions检索到,并且被删除的文件ID列表可通过list=filearchive检索到。

参数:
title

要恢复的页面标题。

这个参数是必须的。
reason

恢复的原因。

默认:(空)
tags

要在删除日志中应用到实体的更改标签。

值(以|替代物分隔):
timestamps

要回复的修订的时间戳。如果timestampsfileids都为空,所有将被恢复。

类型:时间戳列表(允许格式
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
fileids

要恢复的文件修订ID。如果timestampsfileids都为空,所有将被恢复。

类型:整数列表
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
watchlist

无条件地将页面加入至当前用户的监视列表或将其移除(忽略机器人用户),使用设置或不更改监视。

以下值中的一个:nochange、preferences、unwatch、watch
默认:preferences
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=unlinkaccount

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

从当前用户移除已连接的第三方账户。

参数:
request

使用此身份验证请求,通过返回自action=query&meta=authmanagerinfoidamirequestsfor=unlink

这个参数是必须的。
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。
例子:
尝试移除当前用户的,与FooAuthenticationRequest相关联提供方的链接。
api.php?action=unlinkaccount&request=FooAuthenticationRequest&token=123ABC [在沙盒中打开]

action=upload

main | upload
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

上传文件,或获取正在等待中的上传的状态。

可以使用的几种方法:

  • 直接上传文件内容,使用file参数。
  • 成批上传文件,使用filesizechunkoffset参数。
  • 有MediaWiki服务器从URL检索一个文件,使用url参数。
  • 完成一次由于警告而失败的早前上传,使用filekey参数。

需要注意,当发送file时,HTTP POST必须做为一次文件上传(也就是使用multipart/form-data)完成。

参数:
filename

目标文件名。

comment

上传注释。如果没有指定text,那么它也被用于新文件的初始页面文本。

默认:(空)
tags

更改标签以应用于上传日志记录和文件页面修订中。

值(以|替代物分隔):
text

用于新文件的初始页面文本。

watch
已弃用。

监视页面。

类型:布尔型 (详情)
watchlist

无条件地将页面加入至当前用户的监视列表或将其移除(忽略机器人用户),使用设置或不更改监视。

以下值中的一个:nochange、preferences、watch
默认:preferences
ignorewarnings

忽略任何警告。

类型:布尔型 (详情)
file

文件内容。

必须使用POST方法及multipart/form-data作为文件上传。
url

要检索文件来源的URL。

filekey

用于识别一次临时藏匿的早前上传的关键字。

sessionkey
已弃用。

与filekey相同,基于向后兼容而维护。

stash

如果设置,服务器将临时藏匿文件而不是加入存储库。

类型:布尔型 (详情)
filesize

全部上传的文件大小。

类型:整数
值必须介于0和8,388,608之间。
offset

数据块的偏移量(字节)。

类型:整数
值必须不少于0。
chunk

大块内容。

必须使用POST方法及multipart/form-data作为文件上传。
async

在可能的情况下,使潜在的大文件操作异步进行。

类型:布尔型 (详情)
checkstatus

只检索指定文件密钥的上传状态。

类型:布尔型 (详情)
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=userrights

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

更改一位用户的组成员。

参数:
user

用户。

类型:通过 用户名和用户ID(例如“#12345”) 中任意一种方式指定的用户
userid
已弃用。

改为指定user=#ID

类型:整数
add

将用户加入至这些组中,或如果其已作为成员,更新其所在用户组成员资格的终止时间。

值(以|替代物分隔):automoderated、bilibili、bot、bureaucrat、checkuser、interface-admin、moderator、push-subscription-manager、smwadministrator、smwcurator、smweditor、suppress、sysop、widgeteditor
expiry

到期时间戳。可以是相对值(例如5 months2 weeks)或绝对值(例如2014-09-18T12:34:56Z)。如果只设置一个时间戳,它将被用于所有传递给add参数的组。对于永不过时的用户组,使用infiniteindefiniteinfinitynever

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
默认:infinite
remove

将用户从这些组中移除。

值(以|替代物分隔):automoderated、bilibili、bot、bureaucrat、checkuser、interface-admin、moderator、push-subscription-manager、smwadministrator、smwcurator、smweditor、suppress、sysop、widgeteditor
reason

更改原因。

默认:(空)
token

action=query&meta=tokens取回的“userrights”令牌

出于兼容性考虑,web UI中使用的令牌也被接受。

这个参数是必须的。
tags

要在用户权限日志中应用到实体的更改标签。

值(以|替代物分隔):
例子:
将用户FooBot添加至bot用户组,并从sysopbureaucrat组移除。
api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC [在沙盒中打开]
将ID为123的用户加入至机器人组,并将其从管理员行政员组移除。
api.php?action=userrights&userid=123&add=bot&remove=sysop|bureaucrat&token=123ABC [在沙盒中打开]
添加用户SometimeSysop至用户组sysop,为期1个月。
api.php?action=userrights&user=SometimeSysop&add=sysop&expiry=1%20month&token=123ABC [在沙盒中打开]

action=validatepassword

  • 此模块需要读取权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

验证密码是否符合wiki的密码方针。

如果密码可以接受,就报告有效性为Good,如果密码可用于登录但必须更改,则报告为Change,或如果密码不可使用,则报告为Invalid

参数:
password

要验证的密码。

这个参数是必须的。
user

用户名,供测试账户创建时使用。命名的用户必须不存在。

类型:通过 用户名和用户ID(例如“#12345”) 中任意一种方式指定的用户
email

电子邮件,供测试账户创建时使用。

realname

真实姓名,供测试账户创建时使用。

action=watch

main | watch
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

从当前用户的监视列表中添加或移除页面。

参数:
title
已弃用。

要(取消)监视的页面。也可使用titles

unwatch

如果设置页面将被取消监视而不是被监视。

类型:布尔型 (详情)
continue

当更多结果可用时,使用这个继续。

titles

要工作的标题列表。

通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
pageids

要工作的页面ID列表。

类型:整数列表
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
revids

要工作的修订ID列表。

类型:整数列表
通过|替代物隔开各值。
值的最大值为50(允许更高上限的客户端为500)。
generator

通过执行指定查询模块获得页面列表以工作。

注意:发生器参数名称必须以“g”开头,参见例子。

allcategories
列举所有分类。
alldeletedrevisions
列举由一位用户或在一个命名空间中所有已删除的修订。
allfileusages
列出所有文件用途,包括不存在的。
allimages
按顺序枚举所有图像。
alllinks
列举所有指向至指定命名空间的链接。
allpages
循序列举在指定命名空间中的所有页面。
allredirects
列出至一个命名空间的重定向。
allrevisions
列举所有修订。
alltransclusions
列出所有嵌入页面(使用{{x}}嵌入的页面),包括不存在的。
backlinks
查找所有链接至指定页面的页面。
categories
页面属于的所有分类列表。
categorymembers
在指定的分类中列出所有页面。
deletedrevisions
获取删除的修订版本信息。
duplicatefiles
根据哈希值列出此给定文件的所有副本。
embeddedin
查找所有嵌入指定标题的页面。
exturlusage
列举包含一个指定URL的页面。
fileusage
查找所有使用指定文件的页面。
images
返回指定页面上包含的所有文件。
imageusage
查找所有使用指定图片标题的页面。
iwbacklinks
查找所有链接至指定跨wiki链接的页面。
langbacklinks
查找所有链接至指定语言链接的页面。
links
从指定页面返回所有链接。
linkshere
查找所有链接至指定页面的页面。
pageswithprop
列出所有使用指定页面属性的页面。
prefixsearch
为页面标题执行前缀搜索。
protectedtitles
列出所有被限制创建的标题。
querypage
获取由基于QueryPage的特殊页面提供的列表。
random
获取随机页面集。
recentchanges
列举最近更改。
redirects
返回至指定页面的所有重定向。
revisions
获取修订版本信息。
search
执行一次全文本搜索。
templates
返回指定页面上所有被嵌入的页面。
transcludedin
查找所有嵌入指定页面的页面。
watchlist
在当前用户的监视列表中获取对页面的最近更改。
watchlistraw
获得当前用户的监视列表上的所有页面。
以下值中的一个:allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

自动解决在titlespageidsrevids,以及在由generator返回的页面中的重定向。

类型:布尔型 (详情)
converttitles

如有需要,将标题转换为其他变体。只有当wiki的内容语言支持变体转换时才能工作。支持变体转换的语言包括ban、en、crh、gan、iu、kk、ku、shi、sr、tg、uz和zh。

类型:布尔型 (详情)
token

action=query&meta=tokens取回的“watch”令牌

这个参数是必须的。

action=webapp-manifest

  • 此模块需要读取权限。
  • 来源:MobileFrontend
  • 许可协议:GPL-2.0-or-later

返回webapp证明。

format=json

main | json

输出数据为JSON格式。

参数:
callback

如果指定,将输出内容包裹在一个指定的函数调用中。出于安全考虑,所有用户相关的数据将被限制。

utf8

如果指定,使用十六进制转义序列将大多数(但不是全部)非ASCII的字符编码为UTF-8,而不是替换它们。默认当formatversion不是1时。

类型:布尔型 (详情)
ascii

如果指定,使用十六进制转义序列将所有非ASCII编码。默认当formatversion1时。

类型:布尔型 (详情)
formatversion

输出格式

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
现代格式。
latest
Use the latest format (currently 2), may change without warning.
以下值中的一个:1、2、latest
默认:1

format=jsonfm

main | jsonfm

输出数据为JSON格式(使用HTML格式显示)。

参数:
wrappedhtml

作为一个JSON对象返回优质打印的HTML和关联的ResouceLoader模块。

类型:布尔型 (详情)
callback

如果指定,将输出内容包裹在一个指定的函数调用中。出于安全考虑,所有用户相关的数据将被限制。

utf8

如果指定,使用十六进制转义序列将大多数(但不是全部)非ASCII的字符编码为UTF-8,而不是替换它们。默认当formatversion不是1时。

类型:布尔型 (详情)
ascii

如果指定,使用十六进制转义序列将所有非ASCII编码。默认当formatversion1时。

类型:布尔型 (详情)
formatversion

输出格式

1
(没有说明)
2
(没有说明)
latest
(没有说明)
以下值中的一个:1、2、latest
默认:1

format=none

main | none

不输出任何东西。

format=php

main | php

输出数据为序列化PHP格式。

参数:
formatversion

输出格式

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
现代格式。
latest
Use the latest format (currently 2), may change without warning.
以下值中的一个:1、2、latest
默认:1

format=phpfm

main | phpfm

输出数据为序列化PHP格式(使用HTML格式显示)。

参数:
wrappedhtml

作为一个JSON对象返回优质打印的HTML和关联的ResouceLoader模块。

类型:布尔型 (详情)
formatversion

输出格式

1
(没有说明)
2
(没有说明)
latest
(没有说明)
以下值中的一个:1、2、latest
默认:1

format=rawfm

main | rawfm

输出数据为JSON格式,包含调试元素(使用HTML格式显示)。

参数:
wrappedhtml

作为一个JSON对象返回优质打印的HTML和关联的ResouceLoader模块。

类型:布尔型 (详情)

format=xml

main | xml

输出数据为XML格式。

参数:
xslt

如果指定,加入已命名的页面作为一个XSL样式表。值必须是在MediaWiki命名空间以.xsl为结尾的标题。

includexmlnamespace

如果指定,添加一个XML命名空间。

类型:布尔型 (详情)

format=xmlfm

main | xmlfm

输出数据为XML格式(使用HTML格式显示)。

参数:
wrappedhtml

作为一个JSON对象返回优质打印的HTML和关联的ResouceLoader模块。

类型:布尔型 (详情)
xslt

如果指定,加入已命名的页面作为一个XSL样式表。值必须是在MediaWiki命名空间以.xsl为结尾的标题。

includexmlnamespace

如果指定,添加一个XML命名空间。

类型:布尔型 (详情)

数据类型

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

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

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

boolean

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

expiry

到期值是相对的(例如5个月2周)或绝对值(例如2014-09-18T12:34:56Z)。如果没有截止如期,请使用infiniteinfiniteinfinitynever

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年至今的开发组领导)

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