API:パラメーター情報
Appearance
From mediawiki.org
This page is a translated version of the page API:Parameter information and the translation is 89% complete.
Languages:
このページは MediaWiki 操作 API の説明文書の一部です。
| MediaWiki 操作 API |
|---|
| 基本 |
| 認証 |
| 利用者とアカウント |
| ページのオペレーション |
| 検索 |
| 開発者向けユーティリティ |
| チュートリアル |
| 表 · 話 · 編 |
MediaWiki バージョン:
≧ 1.12
他の操作 API モジュール 、およびそのパラメーターに関する情報を取得するGET リクエストです。
APIの説明文書
以下の説明文書は、このサイト (MediaWiki.org) で稼働しているリリース前のバージョンのMediaWikiによって自動的に生成された、Special: ApiHelp/ paraminfo の出力です。
action=paraminfo
(main | paraminfo)
- Source: MediaWiki
- License: GPL-2.0-or-later
Obtain information about API modules.
Specific parameters:
Other general parameters are available.
- modules
List of module names (values of the action and format parameters, or main). Can specify submodules with a +, or all submodules with +*, or all submodules recursively with +**.
- Separate values with | or alternative.
- Maximum number of values is 50 (500 for clients that are allowed higher limits).
- helpformat
Format of help strings.
- One of the following values: html, none, raw, wikitext
- Default: none
- querymodules
- Deprecated.
List of query module names (value of prop, meta or list parameter). Use modules=query+foo instead of querymodules=foo.
- Values (separate with | or alternative): abusefilters, abuselog, allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allmessages, allpages, allredirects, allrevisions, alltransclusions, allusers, authmanagerinfo, babel, backlinks, betafeatures, blocks, categories, categoryinfo, categorymembers, centralnoticeactivecampaigns, centralnoticelogs, checkuser, checkuserformattedblockinfo, checkuserlog, cirrusbuilddoc, cirruscompsuggestbuilddoc, cirrusdoc, codexicons, communityconfiguration, communityrequests-wishes, contributors, deletedrevisions, deletedrevs, description, duplicatefiles, embeddedin, extdistbranches, extdistrepos, extlinks, extracts, exturlusage, featureusage, filearchive, filerepoinfo, fileusage, flowinfo, gadgetcategories, gadgets, globalallusers, globalblocks, globalgroups, globalpreferences, globalrenamequeue, globalrenamestatus, globalusage, globaluserinfo, globalusers, imageinfo, images, imageusage, info, iwbacklinks, iwlinks, langbacklinks, langlinks, languageinfo, languagestats, links, linkshere, linterrors, linterstats, logevents, managemessagegroups, mapdata, messagecollection, messagegroups, messagegroupstats, messagegroupsubscription, messagetranslations, mmcontent, mostviewed, mystashedfiles, notifications, pagecollectionsmetadata, pageimages, pagepropnames, pageprops, pageswithprop, pageterms, pageviews, prefixsearch, protectedtitles, querypage, random, readinglistentries, readinglists, recentchanges, redirects, revisions, search, siteinfo, siteviews, stashimageinfo, tags, templates, threads, tokens, trackingcategories, transcludedin, transcodestatus, unreadnotificationpages, usercontribs, userinfo, users, videoinfo, watchlist, watchlistraw, wbentityusage, wblistentityusage, wikibase, wikisets
- Maximum number of values is 50 (500 for clients that are allowed higher limits).
- mainmodule
- Deprecated.
Get information about the main (top-level) module as well. Use modules=main instead.
- pagesetmodule
- Deprecated.
Get information about the pageset module (providing titles= and friends) as well.
- formatmodules
- Deprecated.
List of format module names (value of format parameter). Use modules instead.
- Values (separate with | or alternative): json, jsonfm, none, rawfm, xml, xmlfm
Examples:
- Show info for action=parse , format=jsonfm , action=query&list=allpages , and action=query&meta=siteinfo .
- api.php?action=paraminfo&modules=parse|phpfm|query%2Ballpages|query%2Bsiteinfo [open in sandbox]
- Show info for all submodules of action=query .
- api.php?action=paraminfo&modules=query%2B* [open in sandbox]
例
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 """ importrequests 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 */ varurl="https://en.wikipedia.org/w/api.php"; varparams={ 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){returnresponse.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 */ varparams={ action:'paraminfo', format:'json', modules:'parse|query+info|query' }, api=newmw.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を導入しました