API:メイン ページ

From MediaWiki.org
Jump to: navigation, search
This page is a translated version of the page API:Main page and the translation is 47% complete.

Outdated translations are marked like this.
Other languages:
العربية • ‎български • ‎বাংলা • ‎Deutsch • ‎English • ‎Esperanto • ‎español • ‎فارسی • ‎français • ‎हिन्दी • ‎Հայերեն • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎Taqbaylit • ‎ಕನ್ನಡ • ‎한국어 • ‎lietuvių • ‎मैथिली • ‎मराठी • ‎Nederlands • ‎occitan • ‎polski • ‎پښتو • ‎português • ‎português do Brasil • ‎română • ‎русский • ‎سنڌي • ‎ไทย • ‎українська • ‎Tiếng Việt • ‎粵語 • ‎中文
Tools clipart.png このページは MediaWiki 操作 API の説明文書の一部です。

MediaWiki 操作 API

v · d · e
このページでは、「操作」API の概要を記述します。 下位トピックや他の API の詳細は、右のメニュー バーを参照してください。

MediaWiki 操作 API は、ウィキの機能、データ、メタデータに、通常は api.phpManual:api.php にある URL 経由で、HTTP でアクセスする便利な手段を提供するウェブ サービスです。 クライアントがaction パラメータを指定して特定の「アクション」を要求したときは、おもに action=query によって情報を得ます。 通称は 究極の MediaWiki API (the MediaWiki API) でしたが、今では MediaWiki に接続するその他のウェブ API MediaWiki があります。たとえば RESTBaseWikidata query service もその一つです。

はじめに[edit]

注 注: 「内部 API」や「PHP API」をお探しの場合は、PHP 開発者が MediaWiki インストレーションに新しい機能を追加できるようにする拡張機能のインターフェイスをご覧ください。

Deprecation notices are sent to the low-traffic mediawiki-api-announce mailing list. 購読をお勧めします。

MediaWiki の操作 API は、MediaWiki のインストレーションを監視したり、自動的に保守するためのボットを作成するために使用できます。 ウェブ API は、MediaWiki のデータベース内のデータへの直接的で高水準なアクセス手段を提供します。 クライアント プログラムは、ウェブ サービスに対して HTTP リクエストを送信することで、ウィキにログインする、データを取得する、変更内容を投稿するという処理を自動的に実行できます。

対応しているクライアントには、ボットNavigation popups などのウェブベース JavaScript クライアント、LiveRCVandal Fighter などのエンド ユーザー アプリケーション、その他のウェブ サイト (Tool Labs のユーティリティ) などがあります。

MediaWiki の新しいインストレーションでは、ウェブ サービスは既定で有効になっていますが、管理者が無効化することができます。

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

単純な例[edit]

この URL は、英語版ウィキペディアのウェブ サービス API に、メインページの本文を送信させます:

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

HTTP GET リクエストを送信するために、あらゆるプログラミング言語を使用できます (単にブラウザーでリンクにアクセスするだけでも構いません)。すると、「Main Page」という名前のページの現在のウィキ マークアップを含む JSON 文書が得られます。 形式を jsonfm に変更することで、「pretty-printed」(読みやすく整形された) HTML が得られます。これはデバッグに役立ちます。

Here is the jsonfm URL as an easier-to-read clickable link.

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

エンドポイント[edit]

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

これが「エンドポイント」です。 MediaWiki ウェブ サービス API のホームページのようなものです。 This URL is the base URL for English Wikipedia's API, just as https://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:

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

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. 例えば、このウィキでは:

<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 script path (like w/api.php).

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

形式 (format)[edit]

format=json This tells the 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. APIは他にも XMLnative PHP のような出力形式をサポートしていますが、使用頻度の低い形式を廃止する (phab:T95715) ことが計画されており、それらの使用はおすすめできません。

操作 (action)[edit]

action=query

The MediaWiki web service API implements dozens of actions and extensions implement many more; the dynamically generated API help documents all available actions on a wiki. In this case, we're using the "query" action to get some information. 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.

操作固有のパラメーター[edit]

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". (%20 は 空白 (スペース) をパーセントエンコーディングしたものです。) 複数のページを照会する場合は、すべてを1件の要求にまとめてネットワークとサーバのリソースを最適化する: 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


さあ、はじめましょう[edit]

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.

クライアントを識別する[edit]

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/; MyCoolTool@example.org) 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/; MyCoolTool@example.org) BasedOnSuperLib/1.4');

Or if you use cURL:

curl_setopt($curl, CURLOPT_USERAGENT, 'MyCoolTool/1.1 (https://example.org/MyCoolTool/; MyCoolTool@example.org) BasedOnSuperLib/1.4');

ログイン[edit]

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

APIエチケット[edit]

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.

便利なリンク[edit]

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:

アーカイブリンク[edit]