ウィキメディア REST API
Appearance
ウィキメディアREST APIは、機械が読める形式でウィキメディアのコンテンツやメタデータへアクセスできるようにします。 大容量使用のケースに重点を置き、ウィキメディアのグローバルに分散されたキャッシュ インフラストラクチャと緊密に統合されています。 その結果、API 利用者は、待ち時間の短縮と大量のリクエストのサポートというメリットを享受できます。
REST APIとその文書は、すべての主要なウィキメディア・プロジェクトで /api/rest_v1/ から入手できます。 たとえば、英語版ウィキペディアのREST APIとその文書はhttps://en.wikipedia.org/api/rest_v1/で入手可能です。
ウィキメディア・プロジェクトのほとんどが英語版ウィキペディアとほぼ同等の機能のREST APIを提供していますが、注目すべき例外がいくつかあります。
- wikimedia.org は例えばページビュー指標などプロジェクト横断型の情報を提供。
- en.wiktionary.org(ウィクショナリー英語版)では試験的に定義のエンドポイントを提供、ウィクショナリーの情報を構造化データとして露出します。 その他の言語への対応は協議中。
バージョン化
REST API はこちらの API バージョン化の方針に準拠します。
使用条件
- REST API を使用すると、ウィキメディアの一般の利用規約ならびにプライバシー保護の方針に同意したものとみなされます。
- 他の API 利用者に及ぼす影響を避けるため、この API に関するクライアント総数はリクエストに毎秒200名の上限を設けてください。多数のエントリポイントではそれに加えて、よりレート制限を規定して、しっかり実施してください。
- 当方から迅速にご連絡できるように、
User-AgentもしくはApi-User-Agentのヘッダを個別に設定してください。メールアドレスもしくは連絡先ページの URL などをお願いします。
その他のAPI
MediaWiki 1.35 以降に同梱した REST API については、メディアウィキ・コア REST 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/地球 | |
関連項目
- RESTBase は廃止されましたが、REST API の背景にその技術を応用
- ブログで 1.0 展開を発表。製品化の重要な複数の使用事例を説明、REST API がウィキメディアのより大規模な戦略にどう適応したか、展開の詳細について要点をいくつか提供。
- API の展開は Node.js を使っています。こちらのブログ投稿にはREST API ならびにその他のサービスを私たちがノード 6 に更新した経験を述べてあります。
- REST API の製品のオーナーはメディアウィキ・プラットフォーム・チーム(MediaWiki Platform Team)。
- Core Platform Team/Initiatives/API Gateway (2020)