API:帮助

This page is a translated version of the page API:Help and the translation is 100% complete.

本页是MediaWiki Action API帮助文档的一部份。

MediaWiki版本：

≥ 1.8

请求GET来显示指定模块的帮助。

API帮助文档

以下文档是Special:ApiHelp/help的输出，由该网站（MediaWiki.org）运行的MediaWiki的预发行版本自动生成。

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]

示例

GET请求

显示指定模块的帮助。

api.php?action=help&modules=query+tokens&wrap=&format=json [在Api沙盒中尝试]

回应

{
    "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\":
...
    }
}

示例代码

Python

#!/usr/bin/python3

"""
    get_help.py

    MediaWiki API Demos
    Demo of `Help` module: Get help for a specified module.

    MIT License
"""

import requests

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
*/

var url = "https://en.wikipedia.org/w/api.php"; 

var params = {
    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){return response.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
*/

var params = {
		action: 'help',
		modules: 'query+tokens',
		wrap: '',
		format: 'json'
	},
	api = new mw.Api();

api.get( params ).done( function ( data ) {
	console.log( data );
} );

可能的错误


代码	信息
badmodule	模块`name`不包含子模块“name2”。

参数历史

v1.25: 启用submodules, recursivesubmodules, wrap, toc
v1.25: 移除querymodules
v1.21: 弃用querymodules
v1.17: 启用action, format, main

参见

API:首页 - 提供MediaWiki操作API的概述。
API:常见问题 - 提供MediaWiki操作API常见问题的解答。