API:Action API/ja

This is an introductory overview. See the menu bar on the right for more detailed sub-topics.

MediaWiki ウェブサービス API (もしくは WebAPI)は、Wikiの機能、データ、メタデータへのアクセス手段を提供します。

はじめに

「内部API」や「PHP API」をお探しでしたら、PHP開発者が自分の設置したMediaWikiに新機能を追加する方法に関する拡張機能のインターフェイスをご覧ください。

MediaWiki のウェブAPIは自分が設置した MediaWiki を監視したり、メンテナンス用のボットを作ったりするために使えます。ウェブAPIは MediaWiki データベースにあるデータへの直接の、高水準なアクセスを提供します。クライアントプログラムはウェブサービスへのHTTPリクエストを介して自動的にウィキにログインし、データを取得し、変更を投稿できます。サポートされているクライアントにはボット、Navigation popupsやLiveRC などの軽量なウェブベースのJavaScript製クライアント、Vandal Fighter などのエンドユーザーアプリケーション、 他のウェブサイト（Tool Labs' utilities）などがあります。

新しい MediaWiki ではウェブサービスはデフォルトで有効になっていますが、管理者はAPIを無効化できます。

MediaWiki には外部向けインターフェイスが他に2つあります。

• Special:Export ページ。ウィキの本文をまとめてXML形式でエクスポートすることができます。詳しくは meta.wikimedia.org の Export のヘルプページをご覧ください。
• （おそらく今あなたが使っている）標準のウェブベースのインターフェイス。ウェブベースのインターフェイスについて詳しくは Manual:Parameters to index.php をお読みください。

単純な例

この URL によって、日本語版 Wikipedia のメインページを得ることができます。

http://ja.wikipedia.org/w/api.php?format=json&action=query&titles=メインページ&prop=revisions&rvprop=content

プログラムによってこの URL を HTTP GET リクエストによって送信すると、もしくはウェブブラウザによって閲覧すると、JSON 形式のページを得られます。このページには Wikipedia のメインページが Wiki マークアップされたものが含まれています。もし format を jsonfm に変更すると、HTMLに整形された結果を得られます。

Let's pick that URL apart to show how it works.

エンドポイント

http://ja.wikipedia.org/w/api.php

これが エンドポイント です。 It's like the home page of the Mediawiki web service API. This URL is the base URL for English Wikipedia's API, just as http://en.wikipedia.org/wiki/ is the base URL for its web site.

If you're writing a program to use English Wikipedia, every URL you construct will begin with this base URL. If you're using a different MediaWiki installation, you'll need to find its endpoint and use that instead. All Wikimedia wikis have endpoints that follow this pattern:

http://en.wikipedia.org/w/api.php      # 英語版ウィキペディアの API
http://nl.wikipedia.org/w/api.php      # オランダ語版ウィキペディアの API
http://commons.wikimedia.org/w/api.php # ウィキメディア・コモンズの API

Template:MW 1.17/ja Since r75621, we have RSD discovery for the endpoint: look for the link rel="EditURI" in the HTML source of any page and extract the api.php URL; the actual link contains additional info. For instance, on this wiki it's:

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

Otherwise, there's no safe way to locate the endpoint on any wiki. 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 ScriptPath (like w/api.php).

Now let's move on to the parameters in the query string of the URL.

形式

format=json

This tells the Wikimedia web service API that we want data to be returned in JSON format. You might also want to try format=jsonfm to get an HTML version of the result that is good for debugging. Even though the API supports many different 出力形式 such as WDDX, XML, YAML and ネイティブ PHP, there are plans to remove all formats except for JSON, so you might not want to use them.

操作

action=query

This is the 'action'. The MediaWiki web service API supports over fifty actions, and they're all documented in the API reference. In this case, we're using "query" to tell the API that we want to get some data.

The "query" action is one of the API's most important actions, and it has extensive documentation of its own. What follows is just an explanation of a single example.

操作特有のパラメーター

titles=Main%20Page

The rest of the example URL contains parameters used by the "query" action. Here, we're telling the web service API that we want information about the Wiki page called "Main Page". (The %20 comes from percent-encoding a space.) If you need to work with multiple pages, please consider putting them all in one request to optimize network and server resources: titles=PageA|PageB|PageC. See the query documentation for details.

prop=revisions

This parameter tells the web service API that we are interested in 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.

Again, this is just one example. 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

Getting started

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

• よくある質問
• The page about input and output formats
• The page about errors and warnings
• Any policies that apply to the wiki you want to access, such as (for Wikimedia Foundation wikis) our terms of use. These terms apply to you when you access or edit using the web service API, just as they do when you use your web browser.

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 (http://example.com/MyCoolTool/; MyCoolTool@example.com) 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. There is currently no other mechanism for a browser-based client to identify itself.

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

ini_set('user_agent', 'MyCoolTool/1.1 (http://example.com/MyCoolTool/; MyCoolTool@example.com) BasedOnSuperLib/1.4');

Or if you use cURL:

curl_setopt($curl, CURLOPT_USERAGENT, 'MyCoolTool/1.1 (http://example.com/MyCoolTool/; MyCoolTool@example.com) 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:Etiquette/ja

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/ja. 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:

• The API sandbox available on all Wikimedia wikis makes it easy to try out different actions interactively.
• The API reference contains automatically-generated descriptions of all actions and parameters.
• Hook into Wikipedia information using PHP and the MediaWiki API (IBM developerWorks article, 17 May 2011)
• Hook into Wikipedia using Java and the MediaWiki API (6 April 2012)
• The API tutorial leads you through hands-on exercises and includes a training video.
• Mailing list for notifications and questions: API mailing list
  • Low-traffic mailing list for announcements only (all posts to this list are posted to mediawiki-api as well): mediawiki-api-announce
• View and report API bugs: Bugzilla (When reporting new bugs, don't forget to set Component=API)
• Browse the API source code
• The current MediaWiki database schema
• Browse the current database schema in git

アーカイブされたリンク

• 2006 API discussion