API:Client code/ja
 | このページは MediaWiki 操作 API の説明文書の一部です。 |
クライアント ライブラリは、開発者が一般的なタスクや基本的なタスクを支援するために使用できるコードを含んでいるため、プロジェクトが API と対話する際にコードを最初から作成する必要はありません。
このページは、MediaWiki 操作 API で使用できるいくつかの推奨クライアント ライブラリの言語ごとの一覧を含んでいます。 推奨は、API:Client_code/Gold_standard を使用した評価に基づいています。
新規または評価されていないライブラリは、API:Client_code/All に追加する必要があります。
API クライアント ライブラリ
「直近の活動」はリポジトリへの最後のコミットを指します。
日付とバージョン番号は2019年06月19日に更新されました。
日付とバージョン番号は2019年06月19日に更新されました。
Awk
| 名前 | 説明 | 最終リリース | リリース日 | 直近の活動 |
|---|---|---|---|---|
| BotWikiAwk | ボットを作成するためのフレームワークとライブラリ ボットの例も含まれています。 | |||
| Wikiget | Awk CLI program to interface with MediaWiki API for read/write including OAuth. |
Bash
| 名前 | 説明 | 最終リリース | リリース日 | 直近の活動 |
|---|---|---|---|---|
| bash-mediawiki | MediaWiki APIを使用した簡単な編集やアップロードを可能にするCurlで書かれた例。 |
C++
| 名前 | 説明 | 最終リリース | リリース日 | 直近の活動 |
|---|---|---|---|---|
| libmediawiki | MediaWiki APIを使用したウィキの簡単な編集を実現するライブラリ。 |
Common Lisp
| 名前 | 説明 | 最終リリース | リリース日 | 直近の活動 |
|---|---|---|---|---|
| cl-mediawiki | A Common Lisp wrapper for the MediaWiki API. |
Elixir
| 名前 | 説明 | 最終リリース | リリース日 | 直近の活動 |
|---|---|---|---|---|
| mediawiki_client_ex | Adapter for the Action API, EventStreams, and ORES. (説明文書) | 0.4.1 |
Go
| 名前 | 説明 | 最終リリース | リリース日 | 直近の活動 |
|---|---|---|---|---|
| go-mediawiki | MediaWiki APIのGoのためのラッパー。 | v0.1 | ||
| go-mwclient | MediaWiki APIのラッパー（maxlag、継続クエリ、OAuthに対応） | v1.2.0 |
Haskell
| 名前 | 説明 | 最終リリース | リリース日 | 直近の活動 |
|---|---|---|---|---|
| haskell mediawiki | MediaWikiのコンテンツを読み取りと書き込みの両方でプログラムによる利用を可能にする、Haskellの完全なバインディング。 | 0.2.6 |
Java
| 名前 | 説明 | 最終リリース | リリース日 | 直近の活動 |
|---|---|---|---|---|
| JavaWikiBotFramework | ウィキペディアの様なMediaWikiを使用したウィキからデータを取得し維持するためのライブラリ。 | 4.0.0 | ||
| jwiki | A library for effortlessly interacting with Wikipedia/MediaWiki. | 1.8.0 | ||
| Bliki Engine | ウィキ構文をHTMLやDocBook、PDFに変換します。 API呼び出しのためのヘルパーライブラリを持ちます。 |
API:Client_code/All#Javaでさらなる利用可能なJavaのライブラリが見つかるかもしれません。
JavaScript
| 名前 | 説明 | 最終リリース | リリース日 | 直近の活動 |
|---|---|---|---|---|
| mwn (Node.js) | Mwn is a modern and feature-rich API client with support for both JavaScript and TypeScript. Has classes for conveniently working with page titles and parsing wikitext. Supports both OAuth and BotPasswords. | v3.0.1 | ||
| mwbot-ts (Node.js) | mwbot-ts is a TypeScript-compatible library featuring a flexible core class and an offline wikitext parser that handles even edge-case wiki markup. With the core class designed to be subclassed, it's suitable for implementing application-specific logic and methods. Supports both OAuth and BotPasswords. | v1.2.1 | ||
| mwbot (Node.js) | MWBot uses the Promise pattern and other ES6 methodologies, optimised for creating bots that make edits. Works with any MediaWiki site. | v2.1.3 | ||
| nodemw (Node.js) | A generic MediaWiki API client for Node.js. | v0.24.1 | ||
| wikiapi (Node.js) | A simple way to access MediaWiki API via JavaScript with simple wikitext parser. | v1.20.0 | ||
| mediawiki.api (browser) | Generic MediaWiki API client for client-side JavaScript. It ships with MediaWiki core as a ResourceLoader module bundle. It abstracts some high-level concepts and provides a generic client for other queries. | Maintained as part of MediaWiki. | ||
In-wiki JavaScript clients:
| 名前 | 説明 | 最終リリース | リリース日 | 直近の活動 |
|---|---|---|---|---|
| mwapilib2 | A layer overtop of the requests. Make JS gadgets easier. | |||
| JsMwApi | A convenience wrapper around raw requests, with some helpers for editing and parsing. | |||
More JavaScript libraries available at API:Client_code/All#JavaScript.
Lua
| 名前 | 説明 | 最終リリース | リリース日 | 直近の活動 |
|---|---|---|---|---|
| dtMediaWiki | Makes query (tokens, userinfo), clientlogin, upload, and logout calls. It handles HTTPS requests and cookies and can be used to upload files to Wikimedia Commons. |
MATLAB
| 名前 | 説明 | 最終リリース | リリース日 | 直近の活動 |
|---|---|---|---|---|
| MatWiki | A preliminary (as of Feb 2019) MATLAB R2016b(9.1.x) client supporting just bot-logins & semantic #ask queries. | v1.0.0 |
.NET
| 名前 | 説明 | 最終リリース | リリース日 | 直近の活動 |
|---|---|---|---|---|
| WikiFunctions | Library with classes for editing and getting lists of pages via the API, used by AutoWikiBrowser. | 6.2.1.0 | ||
| LinqToWiki | Strongly typed library for accessing most of MediaWiki API, with support for autocompletion. | 1.5.0 | ||
| WikiClientLibrary | A .NET Standard & asynchronous MediaWiki API client library for wiki sites. The library also supports Flow/Wikibase/Wikia-specific API. | v0.7.5 |
More .NET libraries available at API:Client code/All#.NET.
OCaml
| 名前 | 説明 | 最終リリース | リリース日 | 直近の活動 |
|---|---|---|---|---|
| ocaml-mediawiki | A high-level binding for the MediaWiki API written in OCaml. |
Perl
| 名前 | 説明 | 最終リリース | リリース日 | 直近の活動 |
|---|---|---|---|---|
| MediaWiki::Bot | A higher-level Perl module with read and write functions. Easily extensible with plugins, for example to provide administrator functions (Evaluation). | 5.006003 | ||
| MediaWiki::API | A Perl module for interfacing with the MediaWiki API with file upload/download and editing support. (Debian package). （評価）。 | 0.41 |
PHP
| 名前 | 説明 | 最終リリース | リリース日 | 直近の活動 |
|---|---|---|---|---|
| mediawiki-api-base | 基本的なMediaWiki APIの利用に使うライブラリ。 | 2.4.0 | ||
| mediawiki-api | MediaWiki APIとの対話のための簡単なライブラリ。 | 0.7.2 | ||
| wikibase-api | ウィキデータのクエリのためのライブラリ。 | 0.7 | ||
API:Client code/All#PHPでさらなる利用可能なPHPのライブラリが見つかるかもしれません。
 | Sometimes people try to use these kind of libraries to access a MediaWiki installation on the same server. This is often unnecessary because MediaWiki itself is written in PHP, especially when the only purpose of the script is interacting with MediaWiki. With require WebStart.php (MW_INSTALL_PATH may need to be set beforehand, see Manual:$IP), a script gets access to MediaWiki components and consequently it can call the API internally or use other MediaWiki classes and functions directly, which greatly reduces server load. |
Python
| 名前 | 型ヒント | 説明 | 最終リリース | リリース日 | 直近の活動 |
|---|---|---|---|---|---|
| Pywikibot docs | はい | Pythonで書かれたスクリプトを集めた、強力なボット作成用ライブラリ。 (PyPI) (Git|リポジトリ) (#pywikibot 接続) (評価)。 | 10.1.0 | ||
| pwiki docs | はい | 使いやすさとシンプルさを重視したボットとツールの開発用のPythonライブラリ。 | 1.1.1 | ||
| mwclient docs | いいえ | ほとんどのAPI機能へのアクセスを提供するPythonのライブラリ。 （PyPI）（評価）。 | 0.10.1 | ||
| wiki-scripts docs | いいえ | ボットの作成やスクリプトのメンテナンス、データ分析を行うためのフレームワーク。 | 1.2 |
Simple Python wrappers for no-abstraction interfaces to the MediaWiki API and basic session handling:
| 名前 | 型ヒント | 説明 | 最終リリース | リリース日 | 直近の活動 |
|---|---|---|---|---|---|
| pywikiapi | いいえ | A minimalistic library that handles some of the core MediaWiki API complexities like handling continuations, login, errors, and warnings, but does not impose any additional abstraction layers. | 1.3.2 | ||
| Wikipedia docs | いいえ | A Python library that makes it easy to access and parse data from Wikipedia. | v1.1 | ||
| wikitools | いいえ | API周りの抽象化レイヤーをいくつか提供します。 Python 3に対応していません。 | 0.41 |
API:Client code/All#Pythonでさらなる利用可能なPythonのライブラリが見つかるかもしれません。
R
| 名前 | 説明 | 最終リリース | リリース日 | 直近の活動 |
|---|---|---|---|---|
| WikipediR | ウィキペディアをはじめとしたウィキメディアの運営するウィキに特化したMediaWiki APIのラッパー。 Can be used to retrieve page text, information about users or the history of pages, and elements of the category tree. | 1.5.0 |
Ruby
| 名前 | 説明 | 最終リリース | リリース日 | 直近の活動 |
|---|---|---|---|---|
| MediaWiki::Butt | Stable and powerful Ruby framework for the API. （評価） | 3.0.0 | ||
| wikipedia-client | APIを使用したRubyのフレームワーク。 | v1.10.0 | ||
| MediaWiki Ruby API | Ruby API client library in active development by Wikimedia Foundation Release Engineering. | 0.71 |
API:Client code/All#Rubyでさらなる利用可能なRubyのライブラリが見つかるかもしれません。
Rust
| 名前 | 説明 | 最終リリース | リリース日 | 直近の活動 |
|---|---|---|---|---|
| Wikibase RS | Wikibase APIと対話し、データをRustデータ構造にシリアル化するRustのライブラリ。 | 0.37 | ||
| mediawiki_rust | Rustで書かれたMediaWikiクライアントのライブラリ。 | |||
| mwbot-rs | MediaWikiでのボット作成用のフレームワーク。 | 0.4.3 | ||
| wiki | MediaWiki APIとの対話のためのライブラリ。 | 0.0.3 |
API:Client code/All#Rustでさらなる利用可能なRustのライブラリが見つかるかもしれません。
Scala
| 名前 | 説明 | 最終リリース | リリース日 | 直近の活動 |
|---|---|---|---|---|
| scalawiki | Scalaで書かれたMediaWikiクライアント。 | 0.6.3 | ||
| dbpedia extraction framework | Data extraction framework for DBpedia with support Wiki source retrieved via MediaWiki API. | DBpedia_2015-10 | ||
| scmw | Simple MediaWiki API wrapper for needs of Commonist image upload tool. | v-0.140.0 |
関連項目
- API:Client code/All — 全ての既知のAPIクライアントライブラリ。
- API:Client code/Gold standard — Describes best practices for action API client libraries.
- Collection of bot libraries on Wikipedia, several of these use the API.
- mediawiki-api-demos — Demo apps and code snippets in Python and JavaScript demonstrating how to use various modules of the MediaWiki Action API.