API:Main page/ja


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

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

はじめに
MediaWiki の操作 API は、MediaWiki のインストレーションを監視したり、自動的に保守するためのボットを作成するために使用できます. ウェブ API は、MediaWiki のデータベース内のデータへの直接的で高水準なアクセス手段を提供します. クライアント プログラムは、ウェブ サービスに対して HTTP リクエストを送信することで、ウィキにログインする、データを取得する、変更内容を投稿するという処理を自動的に実行できます. 対応しているクライアントには、ボット、Navigation popups などのウェブベース JavaScript クライアント、LiveRC、Vandal Fighter などのエンド ユーザー アプリケーション、その他のウェブ サイト ([//tools.wmflabs.org Toolforge]のユーティリティ) などがあります.

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

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


 * Special:Export ページ. ウィキのコンテンツを XML 形式で一括して書き出せるページです. 詳細情報は  をお読みください.
 * 標準のウェブベースのインターフェイス (あなたが今、このページを閲覧するためにおそらく使用しているインターフェイス). ウェブベースのインターフェイスの使用についての情報は  をお読みください.

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

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

URL を分解して機能の仕組みを調べることにします.

エンドポイント
これが「エンドポイント」です. MediaWiki ウェブ サービス API のホームページのようなものです. このURLは英語版ウィキペディアのAPIの基本URLで、ちょうど がこのウェブサイトの基本URLであるのと対比できます.

もし英語版ウィキペディアで走るプログラムを作成するなら、構築するURLすべての冒頭は、この基本URLで始まります. もしそれ以外のMediaWikiインストレーションを使用するなら、まずそのエンドポイントを調べて、それを使用します. ウィキメディアのウィキでは、エンドポイントはそれぞれ以下の形式に従います.

以降はエンドポイントにRSDを用いています. ページ内でHTMLソースの 部分を探し、 URLを抽出します. 実際のリンク先に詳細な説明があります. 例えば、このウィキでは下記の部分が該当します:

これ以外に、どのウィキであってもエンドポイントを安全に見つける方法はありません. 運がいいと、index.phpのフルパスを奇妙な書き換えルールの陰に隠さずに提供してあり、処理は「edit」（あるいは履歴 history）リンクからindex.php (etc.) をapi.phpに書き換えるだけの場合、あるいは既定のscript path（ など）を使えばよい場合などがありえます.

次に注目するのは、URLのクエリ行の変数です.

形式 (format)
APIに対し、データ返り値をJSON形式にするよう指示します. バグ修正に使うHTML版を入手するなら、 を試用してみましょう. APIは他にも XML や native PHP のような出力形式をサポートしていますが、使用頻度の低い形式を廃止する (T95715) ことが計画されており、それらの使用はおすすめできません.

操作 (action)
MediaWikiウェブサービスAPIは何十種類もの操作を実行でき、拡張機能はさらに多くを実行します. API helpを開くと特定のウィキでどんな操作が使えるか、動的な構造の説明文書に網羅してあります. この事例では情報を得るために「query」操作を選びました. 「query」つまり照会（クエリ）とはAPIの最も重要な操作で、専用の詳しい説明文書が用意されています. 下記に示す解説は、たった1つの例を説明しています.

操作固有のパラメーター
上記のURLのサンプルに戻り、「query」操作の変数を見てみましょう. サンプルではウェブサービスAPIに、求めている情報は「Main Page」というウィキページに関するものだと指示しています. (%20 は 空白 (スペース) をパーセントエンコーディングしたものです. ) 複数のページを照会する場合は、すべてを1件の要求にまとめてネットワークとサーバのリソースを最適化する:. 詳細はクエリの説明文書を参照してください.

単一のページを対象に、多くの情報、つまりproperties（属性）を照会できます. 属性という変数はウェブサービスAPIに、ページの特定版から情報を得るように指示します. 特定版について何も情報を与えていないため、APIは最近の更新&mdash;ウィキペディアの現状のメインページの情報を返します.

その結果、この変数によってウェブサービスAPIに対し、そのページの最近の更新の内容を返すように指示します. もしも を与えた場合は、ぺの最近の更新の内容と、さらに直近に編集した利用者の名前を返します.

繰り返しますが、これは一例にすぎません. クエリ（照会）はこちらで詳しく解説し、the API referenceには可能な操作の他、 に与える全ての値の一覧などをまとめてあります.



さあ、はじめましょう
MediaWiki web service APIを使い始める前に、以下の文書を読んでください,


 * FAQ.
 * 入出力フォーマットについてのページ
 * エラーと警告についてのページ
 * Any policies that apply to the wiki you want to access, such as Wikimedia Foundation wikis' terms of use, trademark policy. These terms apply to you when you access or edit using the 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  header that properly identifies your client. Don't use the default  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  header, or you supply an empty or generic one, your request will fail with an HTTP 403 error (cf. 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  header: the browser will use its own. To work around this, use the  header:

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

Or if you use cURL:

ログイン
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, and cache the result, then a request for   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.
 * [//en.wikipedia.org/w/api.php 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)
 * 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 in the MediaWiki-API Phabricator project (When reporting new bugs, don't forget to add MediaWiki-API to Projects)
 * — MediaWikiデータベースの現状のスキーマ
 * — MediaWikiデータベースの現状のスキーマ

アーカイブリンク

 * 2006 API discussion