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
權限：
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年至今的開發組領導）

請將您的評論、建議和問題發送至mediawiki-api@lists.wikimedia.org，或提交錯誤請求至https://phabricator.wikimedia.org/。