API:パラメーター情報
| このページは MediaWiki 操作 API の説明文書の一部です。 |
| MediaWiki バージョン: | ≧ 1.12 |
他の操作 API モジュール、およびそのパラメーターに関する情報を取得するGET リクエストです。
APIの説明文書
例
GET リクエスト
Getting information about
action=parse, prop=info, and a bogus query module:
レスポンス
{
"warnings": {
"paraminfo": {
"*": "The module \"query\" does not have a submodule \"blah\"."
}
},
"paraminfo": {
"helpformat": "none",
"modules": [
{
"name": "parse",
"classname": "ApiParse",
"path": "parse",
...
},
{
"name": "info",
"classname": "ApiQueryInfo",
"path": "query+info",
...
}
]
}
}
サンプル コード
Python
#!/usr/bin/python3
"""
paraminfo.py
MediaWiki API Demos
Demo of `Paraminfo` module: Obtain information about other modules.
MIT License
"""
import requests
S = requests.Session()
URL = "https://en.wikipedia.org/w/api.php"
PARAMS = {
"action": "paraminfo",
"format": "json",
"modules": "parse|query+info|query"
}
R = S.get(url=URL, params=PARAMS)
DATA = R.json()
print(DATA)
PHP
<?php
/*
paraminfo.php
MediaWiki API Demos
Demo of `Paraminfo` module: Get information about other action API modules and their parameters.
MIT License
*/
$endPoint = "https://en.wikipedia.org/w/api.php";
$params = [
"action" => "paraminfo",
"format" => "json",
"modules" => "parse|query+info|query"
];
$url = $endPoint . "?" . http_build_query( $params );
$ch = curl_init( $url );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
$output = curl_exec( $ch );
curl_close( $ch );
$result = json_decode( $output, true );
var_dump( $result );
JavaScript
/*
paraminfo.js
MediaWiki API Demos
Demo of `Paraminfo` module: Get information about other action API modules and their parameters.
MIT License
*/
var url = "https://en.wikipedia.org/w/api.php";
var params = {
action: "paraminfo",
format: "json",
modules: "parse|query+info|query"
};
url = url + "?origin=*";
Object.keys(params).forEach(function(key){url += "&" + key + "=" + params[key];});
fetch(url)
.then(function(response){return response.json();})
.then(function(response) {console.log(response);})
.catch(function(error){console.log(error);});
MediaWiki JS
/*
paraminfo.js
MediaWiki API Demos
Demo of `Paraminfo` module: Get information about other action API modules and their parameters.
MIT License
*/
var params = {
action: 'paraminfo',
format: 'json',
modules: 'parse|query+info|query'
},
api = new mw.Api();
api.get( params ).done( function ( data ) {
console.log( data );
} );
パラメーターの履歴
- v1.25:
querymodules,mainmodule,pagesetmodule,formatmoduleを廃止予定にしましたWhilepagesetmoduleis not available distinctly through themodulesparameter, its parameters are rolled into the modules to which it applies. 例えば、modules=purgeはtitles、pageids、などを返します。helpformatを導入しました
- v1.19:
formatmodulesを導入しました - v1.15:
pagesetmodule,mainmoduleを導入しました