API:首页

From MediaWiki.org
Jump to: navigation, search
This page is a translated version of the page API:Main page and the translation is 67% complete.
Outdated translations are marked like this.
Other languages:
العربية • ‎български • ‎বাংলা • ‎Deutsch • ‎English • ‎español • ‎فارسی • ‎français • ‎हिन्दी • ‎Հայերեն • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎ಕನ್ನಡ • ‎한국어 • ‎lietuvių • ‎मैथिली • ‎मराठी • ‎Nederlands • ‎occitan • ‎polski • ‎پښتو • ‎português • ‎português do Brasil • ‎română • ‎русский • ‎سنڌي • ‎українська • ‎Tiếng Việt • ‎粵語 • ‎中文
Tools clipart.png 本页是MediaWiki action API文档的一部分。
MediaWiki APIAPI:Main page



MediaWiki action API

v · d · e
这是一个关于"action"API的概览。 在右侧的菜单栏中可查看更详细的子主题和其他API

MediaWiki action API是一个通过HTTP来提供对wiki功能、数据与元数据便携访问的Web服务，一般通过api.phpManual:api.php这一URL来实现。 客户端通过指定action来请求相应的动作，一般用action=query来获取信息。 这曾被称为MediaWiki API，但现在还有其他可以连接到MediaWiki的web API，例如RESTBase和维基数据查询服务。

介绍

注意 注意： 如果您是在寻找“内部 API”或者“PHP API”，请查看扩展界面，它允许PHP开发人员向维基百科增加新的功能。

Deprecation notices are sent to the low-traffic mediawiki-api-announce mailing list. Subscription is recommended.

MediaWiki action API可以用于监视维基百科的新增条目或者制作机器人来自动维护。 它提供了直接、高级别的对包含在MediaWiki数据库中的数据的访问。 客户端程序可以通过制作HTTP请求给web服务，自动登录wiki、获取数据并发布更改。 支持的客户端包括机器人程序、基于web的轻量级JavaScript（例如导航popup和LiveRC）、最终用户应用程序（例如Vandal Fighter）和其他web网站（工具实验室的实用工具）。

新安装的MediaWiki中，此web服务默认启用，但管理员可以把它禁用。

對於MediaWiki有另外兩個朝外的接口：

简单例子

这个URL让英文维基百科的web服务API向您传送首页的内容：

https://en.wikipedia.org/w/api.php?action=query&titles=Main%20Page&prop=revisions&rvprop=content&format=json

用任意编程语言向这个URL发送一个HTTP GET请求（或直接在浏览器中打开这个链接），您便可得到一个JSON文档，其中包含“Main Page”页面中当前的wiki代码。这就是一个能运作的web服务API。 把格式更改为jsonfm将会返回一个“装饰过的”HTML 结果，使之更适合于调试。

下面的链接是一个易读的jsonfm格式的请求结果。

api.php?action=query&titles=Main%20Page&prop=revisions&rvprop=content&format=jsonfm [在Api沙盒中尝试]

我们来分解这个URL，以展示它如何工作。

接入点

https://en.wikipedia.org/w/api.php

這是端點'。 這就像MediaWiki的Web服務API的主頁。 這個URL是英文維基百科的API的基礎URL，就像https://en.wikipedia.org/wiki/網址是其網站的基本URL。

如果您写一个使用英文维基百科的程序，每一个您需要构造的URL都以这个基础URL开头。 如果您在其他MediaWiki系统上操作，您需要找到它的接入点，并相应地使用那个地址。所有Wikimedia的wiki的接入点都符合这个模式：

https://www.mediawiki.org/w/api.php     # MediaWiki API
https://en.wikipedia.org/w/api.php      # 英语维基百科API
https://nl.wikipedia.org/w/api.php      # 荷兰语维基百科API
https://commons.wikimedia.org/w/api.php # 维基共享资源API


MediaWiki版本： ≥ 1.17

从r75621开始，我们在末端使用RSD：寻找任意页面的HTML源代码中的link rel="EditURI"，并提取api.php URL；这是包含额外信息的实际链接。 例如，本維基是：

<link rel="EditURI" type="application/rsd+xml" href="//www.mediawiki.org/w/api.php?action=rsd" />

否則，沒有安全的方式找到任何維基端點。 If you're lucky, either the full path to index.php will not be hidden under strange rewrite rules so that you'll only have to take the "edit" (or history) link and replace index.php (etc.) with api.php, or you'll be able to use the default script path (like w/api.php).

现在让我们接着了解URL中查询字符串的参数。

格式

format=json 这是向API请求返回JSON格式的数据。 可能你也会想去尝试format=jsonfm来得到一个易于调试的HTML格式的结果。 API同时也支持其它的输出格式 例如XML和原生PHP，但是我们计划移除一些不常用的格式(phab:T95715)，我们不建议您去使用它们。

操作

action=query

MediaWiki web service API接口拥有很多的操作和扩展接口；动态生成的API帮助文档拥有wiki上所有可用操作的描述。 在这种情况下，我们使用“query”操作来获取信息。

“query”操作是API最重要的操作之一，并且具有大量的技术文档。

下面是一个简单例子和它的解释。

特定行为的参数

titles=Main%20Page

示例URL的剩余部分包含由“query”操作使用的参数。 Here, we're telling the web service API that we want information about the Wiki page called "Main Page". （%20来自百分号编码空格。） If you need to query multiple pages, put them all in one request to optimize network and server resources: titles=PageA|PageB|PageC. 参见查询文档以获取详情。

prop=revisions

You can request many kinds of information, or properties, about a page. This parameter tells the web service API that we want information about a particular revision of the page. Since we're not specifying any revision information, the API will give us information about the latest revision — the main page of Wikipedia as it stands right now.

rvprop=content

Finally, this parameter tells the web service API that we want the content of the latest revision of the page. If we passed in rvprop=content|user instead, we'd get the latest page content and the name of the user who made the most recent revision.

再次注意，这只是一个示例。 Queries are explained in more detail here, and the API reference lists all the possible actions, all the possible values for rvprop, and so on.

An introduction to the API by Roan Kattouw at the San Francisco Hackathon January 2012


入门

Before you start using the MediaWiki web service API, be sure to read these documents:

Beyond that point, what you need to read depends on what you want to do. The right-hand menu links to detailed, task-specific documentation, and some more general guidelines are given below.

验证您的客户端

When you make HTTP requests to the MediaWiki web service API, be sure to specify a User-Agent header that properly identifies your client. Don't use the default User-Agent provided by your client library, but make up a custom header that identifies your script or service and provides some type of means of contacting you (e.g., an e-mail address).

An example User-Agent string might look like:

MyCoolTool/1.1 (https://example.org/MyCoolTool/; [email protected]) BasedOnSuperLib/1.4

On Wikimedia wikis, if you don't supply a User-Agent header, or you supply an empty or generic one, your request will fail with an HTTP 403 error (cf. m:User-Agent policy). Other MediaWiki installations may have similar policies.

If you are calling the API from browser-based JavaScript, you won't be able to influence the User-Agent header: the browser will use its own. To work around this, use the Api-User-Agent header:

// Using XMLHttpRequest
xhr.setRequestHeader( 'Api-User-Agent', 'Example/1.0' );

// Using jQuery
$.ajax( {
    url: remoteUrlWithOrigin,
    data: queryData,
    dataType: 'json',
    type: 'POST',
    headers: { 'Api-User-Agent': 'Example/1.0' },
    success: function(data) {
       // do something with data
    }
} );

// Using mw.Api, specify it when creating the mw.Api object
var api = new mw.Api( {
    ajax: {
        headers: { 'Api-User-Agent': 'Example/1.0' }
    }
} );
api.get( {...} ).done(function(data) {
    // do something with data
});

In PHP, you can identify your user-agent with code such as this:

ini_set('user_agent', 'MyCoolTool/1.1 (https://example.org/MyCoolTool/; [email protected]) BasedOnSuperLib/1.4');

或如果您使用cURL：

curl_setopt($curl, CURLOPT_USERAGENT, 'MyCoolTool/1.1 (https://example.org/MyCoolTool/; [email protected]) BasedOnSuperLib/1.4');

登录

Your client will probably need to log in to MediaWiki, possibly via its own user account. See the login manual page for details.

API使用礼仪

另请阅读API:礼仪

If your requests obtain data that can be cached for a while, you should take steps to cache it, so you don't request the same data over and over again. More information about rate-limiting, concurrency, and general API etiquette can be found at API:Etiquette. Some clients may be able to cache data themselves, but for others (particularly JavaScript clients), this is not possible.

Per the HTTP specification, POST requests cannot be cached. Therefore, whenever you're reading data from the web service API, you should use GET requests, not POST.

Also note that a request cannot be served from cache unless the URL is exactly the same. If you make a request for api.php?....titles=Foo|Bar|Hello, and cache the result, then a request for api.php?....titles=Hello|Bar|Hello|Foo will not go through the cache — even though MediaWiki returns the same data!

You should take care to normalize the URLs you send to the MediaWiki web service, so that slightly different user input won't cause you to waste time on unnecessary HTTP requests. You can normalize a list of page titles by removing duplicates and sorting the titles alphabetically. Similar techniques will work for other kinds of data.

实用链接

The menu bar on the right side of this page links to more detailed, task-specific documentation. Here are some links having to do with the API as a whole:

存档链接

Retrieved from "https://www.mediawiki.org/w/index.php?title=API:Main_page/zh&oldid=2347637"