MediaWiki API 說明
此頁為自動產生的 MediaWiki API 說明文件頁面。
說明文件與範例:https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=help
(main | help)
- 來源:MediaWiki
- 授權條款:GPL-2.0-or-later
顯示指定模組的說明。
參數:
- modules
顯示說明的模組(action 與 format 參數的值、或 main)。可透過 + 來指定子模組。
- 將幾個值以 | 或 alternative 分隔。
- 值的最大數目為 50(用於客戶端允許的較高限制為 500)。
- 預設值:main
- submodules
包含用於命名模組之子模組的說明。
- 類型:布林值(詳細資訊)
- recursivesubmodules
包含遞迴子模組的說明。
- 類型:布林值(詳細資訊)
- wrap
在標準 API 回應結構裡包裹輸出。
- 類型:布林值(詳細資訊)
- toc
在 HTML 輸出裡包含目錄。
- 類型:布林值(詳細資訊)
範例:
- 主模組使用說明
- api.php?action=help [在沙盒中開啟]
- 用於 action=query 與其所有子模組的幫助。
- api.php?action=help&modules=query&submodules=1 [在沙盒中開啟]
- 一個頁面中的所有說明。
- api.php?action=help&recursivesubmodules=1 [在沙盒中開啟]
- 說明模組自身的說明。
- api.php?action=help&modules=help [在沙盒中開啟]
- 兩個查詢子模組的說明。
- api.php?action=help&modules=query+info|query+categorymembers [在沙盒中開啟]