MediaWiki API帮助

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

文档和示例:https://www.mediawiki.org/wiki/Special:MyLanguage/API:主页

主模块

状态:mediawikiapi是一个成熟而稳定的接口,受到了积极的支持和改进。当我们试图避免它时,我们可能偶尔需要做一些突破性的改变;订阅mediawiki api公告邮件列表更新通知。

错误请求:当错误的请求被发送到API时,将发送一个带有关键字“MediaWiki API错误”的HTTP标头,然后标头的值和返回的错误代码都将设置为相同的值。有关详细信息,请参阅API:错误和警告.

参数:
行动

要执行的操作。

abusefiltercheckmatch匹配
检查AbuseFilter是否与一组变量、编辑或记录的AbuseFilter事件匹配。
abusefilterchecksyntax
检查AbuseFilter筛选器的语法。
AbuseFiltereValex表达式
计算AbuseFilter表达式。
abusefilterunblockautopromote
由于abusefilter结果,取消阻止用户接收自动提示。
隐私详细信息
查看AbuseLog条目的私有详细信息。
聚合组
管理聚合邮件组。
防波堤
对用户名进行正常化检查。
阻止用户。
中央标志
获取一个centralauthtoken,用于向附加的wiki发出经过身份验证的请求。
centralnoticecdncacheupdatebanner
针对请求的横幅和语言,请求清除存储在CDN(前端)缓存中的横幅内容
中央中耳道数据
为给定的项目选择横幅和所需的数据
centralnoticequerycampaign公司
获取活动的所有配置设置。
更改身份验证数据
更改当前用户的身份验证数据。
更改内容模型
更改页面的内容模型
支票令牌
检查令牌的有效性action=query&meta=令牌.
卷云配置转储
CirruseArch配置的转储。
卷云测绘场
这个wiki的cirrusearch映射的转储。
卷云剖面倾倒区
这个wiki的cirrusearch个人资料的转储。
卷云设置转储
此wiki的CirruseArch设置的转储。
clearhasmsg公司
清除哈斯姆格当前用户的标志。
客户端登录
使用交互流登录到wiki。
代码差异
从系统差异代码备份中获取格式化代码。
代码修订更新
向修订提交注释、新状态和标记。
代码更新
从主版本控制系统更新CodeReview存储库数据。
比较
找出两页之间的差别。
创建帐户
创建新的用户帐户。
删除
删除页面。
删除全局帐户
删除全局用户。
echomarkread公司
将当前用户的通知标记为已读。
echomarkseen公司
将通知标记为对当前用户可见。
回声静音
将来自某些用户或页面的通知静音或取消静音。
编辑
创建和编辑页面。
编辑邮件列表
编辑群发邮件传递列表。
电子邮件用户
给用户发电子邮件。
展开模板
展开wikitext中的所有模板。
fancycaptchareload公司
买一个新的FancyCaptcha。
特色饲料
返回特色内容源。
饲料供给
返回用户的贡献源。
最近的变化
返回最近的更改源。
螺纹
返回讨论线程的源。
饲料观察表
返回监视列表源。
文件还原
将文件还原为旧版本。
允许在结构化讨论页上执行操作。
流涎管
在wikitext和HTML之间转换文本。
谢谢
发送一个公开的感谢通知以获取流评论。
全局块
全局阻止或取消阻止用户。
全球参考文献综述
更改当前用户的全局首选项的本地覆盖。
全球参考文献
更改当前用户的全局首选项。
全球用户权利
在全局组中添加/删除用户。
图表
访问图形标记功能。
小组评审
设置消息组工作流状态。
帮助
显示指定模块的帮助。
图像旋转
此模块已被禁用。
进口
从其他wiki或XML文件导入页面。
jsonconfig
允许直接访问JsonConfig子系统。
语言搜索
在任何脚本中搜索语言名称。
链接帐户
将第三方提供商的帐户链接到当前用户。
登录
登录并获取身份验证cookies。
注销
注销并清除会话数据。
管理标签
执行与更改标签相关的管理任务。
群发短信
向页面列表发送消息。
合并历史
合并页面历史记录。
移动
移动页面。
新闻稿订阅
订阅或取消订阅时事通讯。
开放式搜索
使用OpenSearch协议搜索wiki。
选项
更改当前用户的首选项。
参数信息
获取有关API模块的信息。
解析
解析内容并返回解析器输出。
巡逻
浏览一页或修订本。
保护
更改页面的保护级别。
净化
清除给定标题的缓存。
查询
从MediaWiki获取数据。
删除身份验证数据
删除当前用户的身份验证数据。
重置密码
向用户发送密码重置电子邮件。
修订删除
删除和取消删除修订。
回降
撤消对页面的最后一次编辑。
相对标准偏差
导出RSD(非常简单的发现)模式。
搜索翻译
搜索翻译。
设置全局帐户状态
设置全局用户的状态。
setnotificationtimestamp
更新关注页面的通知时间戳。
设置页语言
换页。
短发
将长URL缩短为较短的URL。
站点矩阵
获取Wikimedia站点列表。
垃圾邮件列表
根据SpamBlacklist验证一个或多个URL。
流配置
公开事件流配置
罢工
允许管理员罢工或取消表决。
标签
在单个修订或日志条目中添加或删除更改标记。
模板数据
获取TemplateData扩展存储的数据。
感谢
编辑给你发了一封感谢信。
螺纹作用
允许对线程和线程讨论中的帖子执行操作。
标题栏
根据标题栏列表验证页面标题、文件名或用户名。
代码转换
具有“transcode reset”权限的用户可以重置并重新运行转换代码作业。
翻译类
查询所有翻译辅助工具。
翻译回顾
标记已审核的翻译。
TTM服务器
从翻译记忆中查询建议。
解除封锁
取消阻止用户。
撤消删除
恢复已删除页面的修订。
取消帐户链接
从当前用户中删除链接的第三方帐户。
上传
上载文件,或获取挂起上载的状态。
用户权限
更改用户的组成员身份。
验证密码
根据wiki的密码策略验证密码。
在当前用户的监视列表中添加或删除页面。
webapp清单
返回webapp清单。
网络认证
API模块,用于在注册/身份验证过程中在服务器和客户端之间进行通信
维基爱情
将WikiLove交给其他用户。
无线连接
已弃用。返回移动视图所需的数据。
代币
已弃用。获取数据修改操作的令牌。
弹跳手
内部。收到一封退回的电子邮件并处理它来处理失败的收件人。
类别树
内部。CategoryTree扩展的内部模块。
CSP报告
内部。浏览器用于报告违反内容安全策略的情况。除非由符合CSP的web浏览器自动使用,否则不应使用此模块。
讨论工具
内部。返回初始化讨论工具所需的元数据。
讨论工具编辑
内部。编辑摘要。
jsondata公司
内部。检索本地化的JSON数据。
管理消息组
内部。在导入过程中,将消息添加为组中现有消息或新消息的重命名
燕麦有效期
内部。验证双因素身份验证(OAST)令牌。
阅读列表
内部。读取列表写入操作。
记录皮棉
内部。在数据库中记录lint错误
清理地图数据
内部。为Kartographer执行数据扩展验证
scribunto控制台
内部。用于从Scribunto控制台处理XHR请求的内部模块。
斯塔舍德特
内部。在共享缓存中准备编辑。
时间文本
内部。提供定时文本内容供<track>元素使用
平移检查
内部。验证翻译。
ULS定位
内部。得到ULS在给定语言中的本地化。
乌尔塞特朗
内部。更新用户首选的界面语言。
视觉编辑器
内部。从Parsoid服务返回页面的HTML5。
可视化编辑
内部。将HTML5页面保存到MediaWiki(通过Parsoid服务转换为wikitext)。
以下值之一:abusefiltercheckmatch匹配,abusefilterchecksyntax,AbuseFiltereValex表达式,abusefilterunblockautopromote,AbuselogPrivate详细信息,聚合组,防波堤,,中央标志,centralnoticecdncacheupdatebanner,中央中耳道数据,centralnoticequerycampaign公司,更改身份验证数据,更改内容模型,支票令牌,卷云配置转储,卷云测绘场,卷云剖面倾倒区,卷云设置转储,clearhasmsg公司,客户端登录,代码差异,代码修订更新,代码更新,比较,创建帐户,删除,删除全局帐户,echomarkread公司,echomarkseen公司,回声静音,编辑,编辑邮件列表,电子邮件用户,展开模板,fancycaptchareload公司,特色饲料,饲料供给,最近的变化,螺纹,饲料观察表,文件还原,流涎管,,谢谢,全局块,全球参考文献综述,全球参考文献,全球用户权利,图表,小组评审,帮助,图像旋转,进口,jsonconfig,语言搜索,链接帐户,登录,注销,管理标签,群发短信,合并历史,移动,新闻稿订阅,开放式搜索,选项,参数信息,解析,巡逻,保护,净化,查询,删除身份验证数据,重置密码,修订删除,回降,相对标准偏差,搜索翻译,设置全局帐户状态,setnotificationtimestamp,设置页语言,短发,站点矩阵,垃圾邮件列表,流式配置,罢工,标签,模板数据,感谢,螺纹作用,标题栏,代码转换,翻译类,翻译回顾,TTM服务器,解除封锁,撤消删除,取消链接帐户,上传,用户权限,验证密码,,webapp清单,网络认证,维基爱情,无线连接,代币,弹跳手,类别树,CSP报告,讨论工具,讨论工具编辑,jsondata公司,管理消息组,燕麦有效期,阅读列表,记录皮棉,清理地图数据,scribunto控制台,斯塔舍德特,时间文本,平移检查,ULS定位,乌尔塞特朗,视觉编辑器,可视化编辑
默认值:帮助
格式

输出的格式。

json格式
以JSON格式输出数据。
jsonfm公司
以JSON格式输出数据(以HTML格式打印)。
没有人
什么也不输出。
菲律宾比索
以序列化的PHP格式输出数据。
phpfm公司
以PHP格式序列化的数据(以PHP格式打印)。
拉夫姆
以JSON格式输出数据,包括调试元素(以HTML格式打印)。
xml
以XML格式输出数据。
XML调频
以XML格式输出数据(以HTML格式打印)。
以下值之一:json格式,jsonfm公司,没有人,菲律宾比索,phpfm公司,拉夫姆,xml,XML调频
默认值:jsonfm
马克斯拉格

在数据库复制群集上安装MediaWiki时,可以使用最大延迟。要保存导致更多站点复制延迟的操作,此参数可以使客户端等待,直到复制延迟小于指定值。如果延迟过大,错误代码马克斯拉格返回的消息如下等待$host:$lag秒滞后.
看到了吗图谱:Maxlag参数了解更多信息。

类型:整数
斯马塞格

设置s-maxage公司HTTP缓存控制头到这个数秒。从不缓存错误。

类型:整数
默认值:0
最大限度

设置最大年龄HTTP缓存控制头到这个数秒。从不缓存错误。

整数类型:
默认值:0
断言

验证用户是否已登录(如果设置为)用户,已登录(如果设置为)阿农,或在以下情况下拥有bot用户权限:机器人程序.

以下值之一:anon、bot、user
资产

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

类型:用户,按用户名
请求ID

此处给出的任何值都将包含在响应中。可用于区分请求。

服务对象

在结果中包括为请求提供服务的主机名。

类型:布尔型(细节)
限时戳

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

类型:布尔型(细节)
回答:Langinfo

包括用于使用语言错误语言结果呢。

类型:布尔型(细节)
起源

当使用跨域AJAX请求(CORS)访问API时,将其设置为原始域。这必须包含在任何飞行前请求中,因此必须是请求URI(而不是POST主体)的一部分。

对于经过身份验证的请求,它必须与起源头,所以它必须设置为https://en.wikipedia.orghttps://meta.wikimedia.org. 如果此参数与起源头,则返回403响应。如果此参数与起源标题和来源是白名单访问控制允许源允许访问控制凭据将设置标题。

对于未验证的请求,请指定值*. 这会导致访问控制允许源标题要设置,但是访问控制允许凭据所有用户特定的数据都将受到限制。

使用语言

用于消息翻译的语言。action=query&meta=siteinfo具有siprop=语言返回语言代码列表,或指定用户使用当前用户的语言首选项,或指定内容使用此wiki的内容语言。

默认值:用户
错误格式

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

明文
删除HTML标记并替换实体的Wikitext。
维基文本
未解析的wikitext。
html格式
HTML。
未经加工的
消息键和参数。
没有人
没有文本输出,只有错误代码。
公元前
MediaWiki 1.29之前使用的格式。错误语言本地错误被忽略。
以下值之一:bc、html、none、纯文本、raw、wikitext
默认值:bc
错误语言

用于警告和错误的语言。action=query&meta=siteinfo具有siprop=语言返回语言代码列表,或指定内容使用此wiki的内容语言,或指定使用语言使用与使用语言参数。

默认值:uselang
本地错误

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

类型:布尔型(细节)
中央标志

当使用跨域AJAX请求(CORS)访问API时,使用它来验证当前SUL用户的身份。使用action=中央令牌在这个wiki上检索令牌,然后再发出CORS请求。每个令牌只能使用一次,并在10秒后过期。这应该包含在任何飞行前的请求中,因此应该包含在请求URI(而不是POST主体)中。

权限:
书面文件
使用write API
授权对象:所有、用户和机器人
最高限度
在API查询中使用更高的限制(慢查询:500;快速查询:5000)。慢查询的限制也适用于多值参数。
授予:bot和sysop

数据类型

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

采用多个值的参数通常与使用管道字符分隔的值一起提交,例如。参数=值1 |值2参数=值1%7C值2. 如果分隔符必须包含分隔符(001F),则必须使用分隔符(001F)在值前面加上U+001F,例如。参数=%1Fvalue1%1Fvalue2.

API请求中的某些参数类型需要进一步解释:

布尔型

Boolean参数的工作方式类似于HTML复选框:如果指定了参数,不管值是什么,它都被认为是true。对于假值,请完全忽略该参数。

到期

到期值是相对的(例如。5个月2周)或绝对值(例如。2014-09-18T12:34:56Z). 如果没有过期,请使用无限的,无限期的,无穷从未.

时间戳

时间戳可以多种格式指定,请参阅mediawiki.org上记录的时间戳库输入格式了解详情。建议使用ISO 8601日期和时间:2001-01-15T14:56:00Z. 另外,字符串现在可用于指定当前时间戳。

模板化参数

模板化参数支持这样的情况:API模块需要为其他某个参数的每个值指定一个值。例如,如果有一个API模块请求水果,它可能有一个参数水果指定请求的水果和模板化参数{水果}-数量指定每种水果的数量。一个需要1个苹果、5个香蕉和20个草莓的API客户机可以发出如下请求水果=苹果|香蕉|草莓和苹果数量=1&香蕉数量=5&草莓数量=20.

信用

API开发者:

  • Yuri Astrakhan(创建者,首席开发者,2006年9月-2007年9月)
  • Roan Kattouw(首席开发人员,2007年9月至2009年9月)
  • 维克多·瓦西里耶夫
  • Bryan Tong Minh先生
  • 萨姆·里德
  • Brad Jorsch(首席开发商2013年至今)

请将您的问题和建议发送到wiki@media.orghttps://phabricator.wikimedia.org/.