API:Parameter information/cs
![]() | Tato stránka je součástí dokumentace k API Action MediaWiki. |
Verze MediaWiki: | ≥ 1.12 |
Žádost GET pro získání informací o dalších akčních modulech API a jejich parametrech.
Dokumentace API
![]() | Následující dokumentace je výstupem Special: |
action=paraminfo
- Source: MediaWiki
- License: GPL-2.0-or-later
Obtain information about API modules.
- 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, contributors, deletedrevisions, deletedrevs, description, duplicatefiles, embeddedin, extdistbranches, extdistrepos, extlinks, extracts, exturlusage, featureusage, filearchive, filerepoinfo, fileusage, flowinfo, gadgetcategories, gadgets, globalallusers, globalblocks, globalgroups, globalpreferences, globalrenamestatus, globalusage, globaluserinfo, 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, oath, pageimages, pagepropnames, pageprops, pageswithprop, pageterms, pageviews, prefixsearch, protectedtitles, querypage, random, readinglistentries, readinglists, recentchanges, redirects, revisions, search, siteinfo, siteviews, stashimageinfo, tags, templates, threads, tokens, 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, php, phpfm, rawfm, xml, xmlfm
- 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]
Příklad
Dotazování přes GET
action=parse
, prop=info
a modulu falešných dotazů:
Odpověď
{
"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",
...
}
]
}
}
Ukázkový kód
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 );
} );
Historie parametrů
- v1.25:
- Zastaralé
querymodules
,mainmodule
,pagesetmodule
,formatmodule
Zatímcopagesetmodule
není k dispozici zřetelně prostřednictvím parametrumodules
, jeho parametry jsou zapsány do modulů, kterých se týká. Napříkladmodules=purge
vrátítitles
,pageids
atd. - Představeno
helpformat
- Zastaralé
- v1.19: Představeno
formatmodules
- v1.15: Představeno
pagesetmodule
,mainmodule
Související odkazy
- API:Informace - získává informace o stránkách.
- API:User - získává informace o uživatelích.
- API:Informace o obrázku - získává informace o obrázcích.