MediaWiki API 說明
此頁為自動產生的 MediaWiki API 說明文件頁面。
說明文件與範例:https://www.mediawiki.org/wiki/API
主要模組
狀態資訊:本頁所展示的所有功能都應正常工作,但是 API 仍在開發當中,將會隨時變化。請訂閱mediawiki-api-announce 郵件清單以便得到更新通知。
錯誤請求:當 API 收到錯誤請求時, HTTP header 將會返回一個包含「MediaWiki-API-Error」的值,隨後 header 的值與錯誤碼將會送回並設定為相同的值。詳細資訊請參閱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 (首席開發者 Sep 2007–2009)
- Victor Vasiliev
- Bryan Tong Minh
- Sam Reed
- Yuri Astrakhan (創立者,首席開發者 Sep 2006–Sep 2007)
- Brad Jorsch (首席開發者 2013–present)
請傳送您的評論、建議以及問題至 mediawiki-api@lists.wikimedia.org 或者回報問題至 https://phabricator.wikimedia.org/。