mediawiki java api_MediaWiki API 帮助

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

主模块

来源：MediaWiki

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

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

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

参数：action要执行的操作。封禁一位用户。

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

清除当前用户的hasmsg标记。

使用交互式流登录wiki。

获取两页面之间的差异。

创建一个新用户账户。

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

删除一个页面。

创建和编辑页面。

电子邮件联系一位用户。

展开wiki文本中的所有模板。

返回用户贡献纲要。

返回最近更改的摘要。

返回监视列表纲要。

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

显示指定模块的帮助。

旋转一幅或多幅图像。

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

使用任何字母搜索语言名称。

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

登录并获取身份验证cookie。

退出并清除会话数据。

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

合并页面历史。

移动一个页面。

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

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

获得关于API模块的信息。

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

巡查页面或修订版本。

更改页面的保护等级。

为指定标题刷新缓存。

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

从当前用户移除身份验证数据。

向用户发送密码重置邮件。

删除和恢复修订版本。

撤销对页面的最近编辑。

导出一个RSD(Really Simple Discovery)架构。

更新监视页面的通知时间戳。

更改页面的语言。

在分享缓存中准备编辑。

从个别修订或日志记录中添加或移除更改标签。

验证一个页面的标题、文件名或用户名是否触发标题黑名单。

获得指定语言的ULS本地化。

解封一位用户。

恢复删除页面的修订版本。

从当前用户移除已连接的第三方账户。

上传文件，或获取正在等待中的上传的状态。

更改一位用户的组成员。

验证密码是否符合wiki的密码方针。

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

已弃用。 获取数据修改操作的令牌。默认：helpformat输出的格式。输出数据为JSON格式。

输出数据为JSON格式(HTML优质打印效果)。

不输出任何东西。

输出数据为序列化PHP格式。

输出数据为序列化PHP格式(HTML优质打印效果)。

输出数据为JSON格式，包含调试元素(HTML优质打印效果)。

输出数据为XML格式。

输出数据为XML格式(HTML优质打印效果)。默认：jsonfmmaxlag最大延迟可被用于MediaWiki安装于数据库复制集中。要保存导致更多网站复制延迟的操作，此参数可使客户端等待直到复制延迟少于指定值时。万一发生过多延迟，错误代码maxlag会返回消息，例如等待$host中：延迟$lag秒。

参见手册:Maxlag参数以获取更多信息。类型：整数smaxage设置s-maxage HTTP缓存控制头至这些秒。错误不会缓存。类型：整数默认：0maxage设置max-age HTTP缓存控制头至这些秒。错误不会缓存。类型：整数默认：0assert如果设置为user就验证用户是否登录，或如果设置为bot就验证是否有机器人用户权限。以下值中的一个：user、botassertuser验证当前用户是命名用户。类型：用户名requestid任何在此提供的值将包含在响应中。可以用以区别请求。servedby包含保存结果请求的主机名。类型：布尔值(详细信息)curtimestamp在结果中包括当前时间戳。类型：布尔值(详细信息)responselanginfo包含在结果中用于uselang和errorlang的语言。类型：布尔值(详细信息)origin当通过跨域名AJAX请求(CORS)访问API时，设置此作为起始域名。这必须包括在任何pre-flight请求中，并因此必须是请求的URI的一部分(而不是POST正文)。

对于已验证的请求，这必须正确匹配Origin标头中的原点之一，因此它已经设置为像Origin页顶，就返回403错误响应。如果此参数匹配Origin页顶并且起点被白名单，将设置Access-Control-Allow-Origin和Access-Control-Allow-Credentials开头。

对于未验证的请求，会指定值*。这将导致Access-Control-Allow-Origin标头被设置，但Access-Control-Allow-Credentials将为false，且所有用户特定数据将受限制。uselang用于消息翻译的语言。siprop=languages可返回语言代码列表，或指定user以使用当前用户的语言设置，或指定content以使用此wiki的内容语言。默认：usererrorformat用于警告和错误文本输出的格式。

plaintext

已移除HTML标签，并被替换实体的Wiki文本。

wikitext

未解析的wiki文本。

html

HTML。

raw

消息关键词和参数。

none

无文本输出，仅包含错误代码。

bc

在MediaWiki 1.29以前版本使用的格式。errorlang和errorsuselocal会被忽略。以下值中的一个：plaintext、wikitext、html、raw、none、bc默认：bcerrorlang用于警告和错误的语言。siprop=languages返回语言代码的列表，或指定content以使用此wiki的内容语言，或指定uselang以使用与uselang参数相同的值。默认：uselangerrorsuselocal如果指定，错误文本将使用来自MediaWiki名字空间的本地自定义消息。类型：布尔值(详细信息)

权限：writeapi使用写入API授予：all、user、bot和patrollerapihighlimits在API查询中使用更高的上限(慢查询：500；快查询：5000)。慢查询的限制也适用于多值参数。授予：bot和sysop

数据类型

至MediaWiki的输入应为NFC标准化的UTF-8。MediaWiki可以尝试转换其他输入，但这可能导致一些操作失败(例如带MD5校验编辑)。

一些在API请求中的参数类型需要更进一步解释：

boolean

布尔参数就像HTML复选框一样工作：如果指定参数，无论何值都被认为是真。如果要假值，则可完全忽略参数。

timestamp

时间戳可被指定为很多格式。推荐使用ISO 8601日期和时间标准。所有时间为UTC时间，包含的任何时区会被忽略。

ISO 8601日期和时间，2001-01-15T14:56:00Z(标点和Z是可选项)

带小数秒(会被忽略)的ISO 8601日期和时间，2001-01-15T14:56:00.00001Z(破折号、冒号和Z是可选的)

MediaWiki格式，20010115145600

一般数字格式，2001-01-15 14:56:00(GMT、+##或-##的可选时区会被忽略)

EXIF格式，2001:01:15 14:56:00

RFC 2822格式(时区可省略)，Mon, 15 Jan 2001 14:56:00

RFC 850格式(时区可省略)，Monday, 15-Jan-2001 14:56:00

C ctime格式，Mon Jan 15 14:56:00 2001

从1970-01-01T00:00:00Z开始的秒数，作为1到13位数的整数(除了0)

字符串now替代多值分隔符

使用多个值的参数通常会与管道符号分隔的值一起提交，例如param=value1|value2或param=value1%7Cvalue2。如果值必须包含管道符号，使用U+001F(单位分隔符)作为分隔符，并在值前加前缀U+001F，例如param=%1Fvalue1%1Fvalue2。

制作人员

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/。