API
Appearance
MediaWikiにはいくつかのアプリケーションプログラミングインターフェース (API) があります。
メディアウィキが提供するウェブ版 API は以下のとおり。
- MediaWiki 操作 API (
api.php) - MediaWiki REST API について (
rest.php)
操作API Action API はより広範な機能性を提供、その点、(より後発の) REST API は URL 構成がより優れていて挙動も早めです。
メディアウィキには以下のソフトウェア API 類があります。
- MediaWiki PHP API、PHP で MediaWiki の拡張機能を開発するために使用できます
- MediaWiki JavaScript API (mw)、利用者スクリプトとガジェットを開発して、MediaWiki ユーザー インターフェイスを拡張するために使用できます。
MediaWiki 操作 API と MediaWiki JavaScript API はどちらもモジュール式であることに注意してください: どちらも拡張機能によって拡張できるため、利用可能なAPIモジュールはウィキごとに異なる可能性があります。[1] MediaWiki コアに組み込まれているAPIモジュールはほとんどの MediaWikiウィキで利用できますが、組み込みの操作 API モジュールは無効にすることもできます。
MediaWiki ウェブサイトの文脈内であれば、JavaScript から 操作 API へアクセスするには mw.Api JavaScript API を経由。 (mw.ForeignApi 承認済みのサイト間申請、たとえば WMF ウィキ類の場合。) いつもお使いのプログラム言語に対応するライブラリから MediaWiki 操作 API にアクセスする手順は、API:クライアント コード をご参照ください。
ウィキメディアの各種プロジェクトと API 類
ウィキメディアの各種プロジェクトで採用できる API 類の情報は、Wikimedia APIs をご参照ください。
関連項目
MediaWiki API 類に関する指摘、アイデアの追跡は リンク元 Phabricator をご参照ください:
- MediaWiki 操作 API の Phabricator タスク
- PHP API に属する MediaWiki-Core-Hooks の Phabricator タスク
- MediaWiki コアもしくは拡張機能についてJavaScript 系のPhabricator タスク
- MediaWiki-REST-API のPhabricator タスク
脚注
- ↑ 操作 API の拡張については、API:拡張機能を参照してください。 JavaScriptモジュールについては、ResourceLoaderを参照してください。