MediaWiki API 帮助

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

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

主模块

  • 来源：MediaWiki
  • 许可协议：GPL-2.0+

状态信息：本页所展示的所有特性都应正常工作，但是API仍在开发当中，将会随时变化。请订阅mediawiki-api-announce 邮件列表以便获得更新通知。

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

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

参数：
action

要执行的操作。

以下值中的一个：block、changeauthenticationdata、checktoken、clearhasmsg、clientlogin、compare、createaccount、delete、edit、emailuser、expandtemplates、feedcontributions、feedrecentchanges、feedwatchlist、filerevert、help、imagerotate、import、linkaccount、login、logout、managetags、mergehistory、move、opensearch、options、paraminfo、parse、patrol、protect、purge、query、removeauthenticationdata、resetpassword、revisiondelete、rollback、rsd、setnotificationtimestamp、spamblacklist、stashedit、tag、titleblacklist、tokens、unblock、undelete、unlinkaccount、upload、userrights、watch
默认：help
format

输出的格式。

以下值中的一个：json、jsonfm、none、php、phpfm、rawfm、xml、xmlfm
默认：jsonfm
maxlag

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

类型：整数
smaxage

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

类型：整数
默认：0
maxage

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

类型：整数
默认：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 [在沙盒中打开]
权限：
writeapi
使用写入API
授予：all、user、bot
apihighlimits
在API查询中使用更高的上限（慢查询：500；快查询：5000）。慢查询的限制也适用于多值参数。
授予：bot、sysop

数据类型

一些在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

制作人员

API 开发人员：

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

请将您的评论、建议和问题发送至[email protected]，或提交错误请求至https://phabricator.wikimedia.org/。

取自“http://mediawiki.supra.tw/index.php?title=特殊:Api帮助”