MediaWiki API 帮助
这是自动生成的MediaWiki API文档页面。
文档和例子:https://www.mediawiki.org/wiki/API:Main_page/zh
主模块
状态信息:本页所展示的所有特性都应正常工作,但是API仍在开发当中,将会随时变化。请订阅mediawiki-api-announce 邮件列表以便获得更新通知。
错误请求:当API收到错误请求时,HTTP header将会返回一个包含"MediaWiki-API-Error"的值,随后header的值与error code将会送回并设置为相同的值。详细信息请参阅API: 错误与警告。
- action
要执行的操作。
- 一个值:block、checktoken、clearhasmsg、compare、createaccount、delete、edit、emailuser、expandtemplates、feedcontributions、feedrecentchanges、feedwatchlist、filerevert、help、imagerotate、import、login、logout、managetags、move、opensearch、options、paraminfo、parse、patrol、protect、purge、query、revisiondelete、rollback、rsd、setnotificationtimestamp、stashedit、tag、tokens、unblock、undelete、upload、userrights、watch
- 默认:help
- format
输出的格式。
- 一个值:dbg、dbgfm、dump、dumpfm、json、jsonfm、none、php、phpfm、rawfm、txt、txtfm、wddx、wddxfm、xml、xmlfm、yaml、yamlfm
- 默认:jsonfm
- maxlag
最大延迟可被用于MediaWiki安装于数据库复制集中。要保存导致更多网站复制延迟的操作,此参数可使客户端等待直到复制延迟少于指定值时。万一发生过多延迟,错误代码maxlag会返回消息,例如等待$host中:延迟$lag秒。
参见Manual: Maxlag parameter以获取更多信息。- smaxage
设置
s-maxage
页顶至这些秒。错误不会缓存。- 默认:0
- maxage
设置
max-age
页顶至这些秒。错误不会缓存。- 默认:0
- assert
如果设置为user就验证用户是否登录,或如果设置为bot就验证是否有机器人用户权限。
- 一个值:user、bot
- requestid
任何在此提供的值将包含在响应中。可能可以用以区别请求。
- servedby
包含保存结果请求的主机名。
- curtimestamp
在结果中包括当前时间戳。
- origin
当通过跨域名AJAX请求(CORS)访问API时,设置此作为起始域名。这必须包括在任何pre-flight请求中,并因此必须是请求的URI的一部分(而不是POST正文)。这必须匹配
Origin
中的一个起点:从头到底,因此它已经设置为像https://zh.wikipedia.org或https://meta.wikimedia.org的东西。如果此参数不匹配Origin
页顶,就返回403错误响应。如果此参数匹配Origin
页顶并且起点被白名单,将设置一个Access-Control-Allow-Origin
开头。- uselang
用于消息翻译的语言。代码列表可从action=query&meta=siteinfo通过siprop=languages获取,或指定user以使用当前用户的语言设置,或指定content以使用此wiki的内容语言。
- 默认:user
- 主模块帮助
- api.php?action=help
- 一个页面中的所有帮助
- api.php?action=help&recursivesubmodules=1
制作人员
API 开发人员:
- Roan Kattouw(2007年9月~2009年的开发组领导)
- Victor Vasiliev
- Bryan Tong Minh
- Sam Reed
- Yuri Astrakhan(创建者,2006年9月~2007年9月的开发组领导)
- Brad Jorsch(2013年至今的开发组领导)
请将您的评论、建议和问题发送至mediawiki-api@lists.wikimedia.org,或提交错误请求在https://phabricator.wikimedia.org/。