API
Appearance
MediaWikiにはいくつかのアプリケーションプログラミングインターフェース (API) があります。
MediaWikiの3つの最も重要なAPIは、次のとおりです。:
- MediaWiki 操作 API(api.php) は、MediaWiki ウィキのコンテンツを読み書きできるWeb 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 | 利用可能かどうか | URLベース | 例 |
|---|---|---|---|
| MediaWiki に同梱されています
ウィキメディアのプロジェクト群で有効になっています |
/api.php | https://ja.wikipedia.org/w/api.php?action=query&prop=info&titles=地球 | |
| MediaWiki 1.35 以降に同梱されています
ウィキメディアのプロジェクト群で有効になっています |
/rest.php | https://ja.wikipedia.org/w/rest.php/v1/page/地球 | |
| MediaWiki に同梱されていません
ウィキメディアのプロジェクト群のみで利用できます |
/api/rest | https://ja.wikipedia.org/api/rest_v1/page/title/地球 | |
関連項目
MediaWiki API 類に関する指摘、アイデアの追跡は リンク元 Phabricator をご参照ください:
- MediaWiki 操作 API の Phabricator タスク
- PHP API に属する MediaWiki-Core-Hooks の Phabricator タスク
- MediaWiki コアもしくは拡張機能についてJavaScript 系のPhabricator タスク
- MediaWiki-REST-API のPhabricator タスク
脚注
- ↑ 操作 API の拡張については、API:拡張機能を参照してください。 JavaScriptモジュールについては、ResourceLoaderを参照してください。