API:Aide
From mediawiki.org
This page is a translated version of the page API:Help and the translation is 100% complete.
Languages:
Cette page fait partie de la documentation de l'API MediaWiki Action.
| API MediaWiki Action |
|---|
| Fonctions de base |
| Authentification |
| Comptes et utilisateurs |
| Opérations sur les pages |
|
| Chercher |
| Outils pour les développeurs |
| Tutoriels |
| v · d · e |
Version de MediaWiki :
≥ 1.8
Requête GET pour afficher l'aide concernant des modules donnés.
Documentation de l'API
La documentation qui suit est le résultat de Special:
action=help
(main | help)
- Source: MediaWiki
- License: GPL-2.0-or-later
Display help for the specified modules.
Specific parameters:
Other general parameters are available.
- modules
Modules to display help for (values of the action and format parameters, or main). Can specify submodules with a +.
- Separate values with | or alternative.
- Maximum number of values is 50 (500 for clients that are allowed higher limits).
- Default: main
- submodules
Include help for submodules of the named module.
- Type: boolean (details)
- recursivesubmodules
Include help for submodules recursively.
- Type: boolean (details)
- wrap
Wrap the output in a standard API response structure.
- Type: boolean (details)
- toc
Include a table of contents in the HTML output.
- Type: boolean (details)
Examples:
- Help for the main module.
- api.php?action=help [open in sandbox]
- Help for action=query and all its submodules.
- api.php?action=help&modules=query&submodules=1 [open in sandbox]
- All help in one page.
- api.php?action=help&recursivesubmodules=1 [open in sandbox]
- Help for the help module itself.
- api.php?action=help&modules=help [open in sandbox]
- Help for two query submodules.
- api.php?action=help&modules=query+info|query+categorymembers [open in sandbox]
Exemples
Requête GET
Obtenir de l'aide pour un module spécifique.
Réponse
{ "help":{ "mime":"text/html", "filename":"api-help.html", "help":"<!DOCTYPE html>\n<html class=\"client-nojs\" lang=\"en\" dir=\"ltr\">\n<head>\n<meta charset=\"UTF-8\"/>\n<title>MediaWiki API help - Wikipedia</title>\n<script>document.documentElement.className=\"client-js\";RLCONF={\"wgBreakFrames\":!0,\"wgSeparatorTransformTable\":[\"\",\"\"],\"wgDigitTransformTable\":[\"\",\"\"],\"wgDefaultDateFormat\":\"dmy\",\"wgMonthNames\": ... } }
Exemple de code
Python
#!/usr/bin/python3 """ get_help.py MediaWiki API Demos Demo of `Help` module: Get help for a specified module. MIT License """ importrequests S = requests.Session() URL = "https://en.wikipedia.org/w/api.php" PARAMS = { "action": "help", "modules": "query+tokens", "wrap": "", "format": "json" } R = S.get(url=URL, params=PARAMS) DATA = R.json() print(DATA)
PHP
<?php /* get_help.php MediaWiki API Demos Demo of `Help` module: Get help for a specified module. MIT License */ $endPoint = "https://en.wikipedia.org/w/api.php"; $params = [ "action" => "help", "modules" => "query+tokens", "wrap" => "", "format" => "json" ]; $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
/* get_help.js MediaWiki API Demos Demo of `Help` module: Get help for a specified module. MIT License */ varurl="https://en.wikipedia.org/w/api.php"; varparams={ action:"help", modules:"query+tokens", wrap:"", format:"json" }; 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
/* get_help.js MediaWiki API Demos Demo of `Help` module: Get help for a specified module. MIT License */ varparams={ action:'help', modules:'query+tokens', wrap:'', format:'json' }, api=newmw.Api(); api.get(params).done(function(data){ console.log(data); });
Erreurs possibles
| Code | Information |
|---|---|
| badmodule | Le module name n’a pas de sous-module « name2 ». |
Historique des paramètres
- v1.25: ajouté
submodules,recursivesubmodules,wrap,toc - v1.25: supprimé
querymodules - v1.21: obsolète
querymodules - v1.17: ajouté
action,format,main
Voir aussi
- API:Main_page - fournit un aperçu de l'API Action de MediaWiki.
- API:FAQ - fournit les réponses aux questions régulièrement posées au sujet de l'API Action de MediaWiki.