API:Client code

Client libraries contain code that developers can use to help with common and basic tasks, so that they don't have to write the code from scratch when their projects interact with an API.

This page contains a set of lists, by language, of several recommended client libraries that can be used with the MediaWiki Action API. The recommendations are based on evaluations using API:Client code/Gold standard .

New and/or unevaluated libraries can be added to API:Client_code/All .

API client libraries

Last activity refers to the last commit in the repository.
Dates and version numbers were updated on 2019-06-19.

Awk

ชื่อ	รายละเอียด	รุ่นล่าสุด	วันที่เผยแพร่	กิจกรรมสุดท้าย
BotWikiAwk	Framework and libraries for creating bots. Includes example bots.			27 มีนาคม พ.ศ. 2562
Wikiget	Awk CLI program to interface with MediaWiki API for read/write including OAuth.			8 มิถุนายน พ.ศ. 2562

Bash

ชื่อ	รายละเอียด	รุ่นล่าสุด	วันที่เผยแพร่	กิจกรรมสุดท้าย
bash-mediawiki	An example with Curl that allows easy editing/uploading of a wiki through the MediaWiki API.			17 สิงหาคม พ.ศ. 2564

C++

ชื่อ	รายละเอียด	รุ่นล่าสุด	วันที่เผยแพร่	กิจกรรมสุดท้าย
libmediawiki	A library that allows easy editing of a wiki through the MediaWiki API.			9 กันยายน พ.ศ. 2560

Common Lisp

ชื่อ	รายละเอียด	รุ่นล่าสุด	วันที่เผยแพร่	กิจกรรมสุดท้าย
cl-mediawiki	A Common Lisp wrapper for the MediaWiki API.			10 พฤศจิกายน พ.ศ. 2559

Elixir

ชื่อ	รายละเอียด	Last release	Release Date	Last activity
mediawiki_client_ex	Adapter for the Action API, EventStreams, and ORES. (Documentation)	0.4.1	20 ธันวาคม พ.ศ. 2565	21 ธันวาคม พ.ศ. 2565

Go

ชื่อ	รายละเอียด	รุ่นล่าสุด	วันที่เผยแพร่	กิจกรรมสุดท้าย
go-mediawiki	Go wrapper for the MediaWiki API.	v0.1	4 พฤศจิกายน พ.ศ. 2556	8 กุมภาพันธ์ พ.ศ. 2560
go-mwclient	Wrapper for the MediaWiki API (supports maxlag, query continuations, OAuth).	v1.2.0	3 มิถุนายน พ.ศ. 2563	3 มิถุนายน พ.ศ. 2563

Haskell

ชื่อ	รายละเอียด	รุ่นล่าสุด	วันที่เผยแพร่	กิจกรรมสุดท้าย
haskell mediawiki	A complete Haskell binding to the MediaWiki API letting you programmatically access (read and write) MediaWiki content.	0.2.6	20 พฤศจิกายน พ.ศ. 2556	20 พฤศจิกายน พ.ศ. 2556

Java

ชื่อ	รายละเอียด	รุ่นล่าสุด	วันที่เผยแพร่	กิจกรรมสุดท้าย
JavaWikiBotFramework	A library to retrieve data from and maintain MediaWiki-based wikis such as Wikipedia.	4.0.0	13 กันยายน พ.ศ. 2559	15 กุมภาพันธ์ พ.ศ. 2562
jwiki	A library for effortlessly interacting with Wikipedia/MediaWiki.	1.8.0	14 เมษายน พ.ศ. 2563	6 พฤษภาคม พ.ศ. 2563
Bliki Engine	Can convert wikicode to HTML, DocBook or PDF. Has a helper library for API calls.			27 เมษายน พ.ศ. 2562

More Java libraries available at API:Client_code/All#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.	v2.0.2	30 กันยายน พ.ศ. 2566	6 เมษายน พ.ศ. 2567
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.0.0	30 ตุลาคม พ.ศ. 2560	1 กุมภาพันธ์ พ.ศ. 2564
nodemw (Node.js)	A generic MediaWiki API client for Node.js.	v0.16.0	16 กันยายน พ.ศ. 2561	29 ตุลาคม พ.ศ. 2564
wikiapi (Node.js)	A simple way to access MediaWiki API via JavaScript with simple wikitext parser.	v1.16.0	1 ตุลาคม พ.ศ. 2563	22 ตุลาคม พ.ศ. 2564
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.			25 กันยายน พ.ศ. 2559
JsMwApi	A convenience wrapper around raw requests, with some helpers for editing and parsing.			11 มิถุนายน พ.ศ. 2557

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.			20 กันยายน พ.ศ. 2561

MATLAB

ชื่อ	รายละเอียด	รุ่นล่าสุด	วันที่เผยแพร่	กิจกรรมสุดท้าย
MatWiki	A preliminary (as of Feb 2019) MATLAB R2016b(9.1.x) client supporting just bot-logins & semantic #ask queries.	v1.0.0	19 กุมภาพันธ์ พ.ศ. 2562	19 กุมภาพันธ์ พ.ศ. 2562

.NET

ชื่อ	รายละเอียด	รุ่นล่าสุด	วันที่เผยแพร่	กิจกรรมสุดท้าย
WikiFunctions	Library with classes for editing and getting lists of pages via the API, used by AutoWikiBrowser.	6.2.1.0	8 มิถุนายน พ.ศ. 2564	5 ตุลาคม พ.ศ. 2566
LinqToWiki	Strongly typed library for accessing most of MediaWiki API, with support for autocompletion.	1.5.0	7 พฤษภาคม พ.ศ. 2558	7 พฤษภาคม พ.ศ. 2558
WikiClientLibrary	A .NET Standard & asynchronous MediaWiki API client library for wiki sites. The library also supports Flow/Wikibase/Wikia-specific API.	v0.7.5	31 มกราคม พ.ศ. 2564	5 พฤศจิกายน พ.ศ. 2565

More .NET libraries available at API:Client code/All#.NET.

OCaml

ชื่อ	รายละเอียด	รุ่นล่าสุด	วันที่เผยแพร่	กิจกรรมสุดท้าย
ocaml-mediawiki	A high-level binding for the MediaWiki API written in OCaml.			29 สิงหาคม พ.ศ. 2555

Perl

ชื่อ	รายละเอียด	รุ่นล่าสุด	วันที่เผยแพร่	กิจกรรมสุดท้าย
MediaWiki::Bot	A higher-level Perl module with read and write functions. Easily extensible with plugins, for example to provide administrator functions (Evaluation). source code on GitHub.	5.006003	7 กรกฎาคม พ.ศ. 2559	7 กรกฎาคม พ.ศ. 2559
MediaWiki::API	A Perl module for interfacing with the MediaWiki API with file upload/download and editing support. (Debian package). (Evaluation).	0.41	13 พฤศจิกายน พ.ศ. 2558	13 พฤศจิกายน พ.ศ. 2558

PHP

ชื่อ	รายละเอียด	รุ่นล่าสุด	วันที่เผยแพร่	กิจกรรมสุดท้าย
mediawiki-api-base	Library for basic MediaWiki api use.	2.4.0	2 พฤศจิกายน พ.ศ. 2560	9 กรกฎาคม พ.ศ. 2562
mediawiki-api	A simple library for interacting with the MediaWiki API.	0.7.2	20 พฤศจิกายน พ.ศ. 2560	6 เมษายน พ.ศ. 2562
wikibase-api	Library for querying Wikidata.	0.7	4 กรกฎาคม พ.ศ. 2559	17 สิงหาคม พ.ศ. 2561

More PHP libraries available at API:Client code/All#PHP.

Python

ชื่อ	Type hints	รายละเอียด	รุ่นล่าสุด	วันที่เผยแพร่	กิจกรรมสุดท้าย
Pywikibot (docs)	Yes	A collection of Python scripts and a powerful library for bot writing. (PyPI) (Git repository) (#pywikibot connect) (Evaluation).	9.5.0	30 ตุลาคม พ.ศ. 2567	พฤศจิกายน พ.ศ. 2567
pwiki (docs)	Yes	A Python library for developing bots/tools, focused on ease of use and simplicity.	1.1.1	15 ตุลาคม พ.ศ. 2564	28 พฤษภาคม พ.ศ. 2565
mwclient (docs)	No	Python library that makes most of the API functions accessible. (PyPI) (Evaluation).	0.10.1	28 พฤษภาคม พ.ศ. 2563	26 กันยายน พ.ศ. 2564
wiki-scripts (docs)	No	Framework for writing bots, maintenance scripts or performing data analysis.	1.2	31 ธันวาคม พ.ศ. 2560	13 มิถุนายน พ.ศ. 2562

Simple Python wrappers for no-abstraction interfaces to the MediaWiki API and basic session handling:

ชื่อ	Type hints	รายละเอียด	รุ่นล่าสุด	วันที่เผยแพร่	กิจกรรมสุดท้าย
pywikiapi	No	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	13 เมษายน พ.ศ. 2562	13 เมษายน พ.ศ. 2562
Wikipedia (docs)	No	A Python library that makes it easy to access and parse data from Wikipedia.	v1.1	24 ธันวาคม พ.ศ. 2556	11 พฤศจิกายน พ.ศ. 2559
wikitools	No	Provides several layers of abstraction around the API. Doesn't support Python 3.	0.41	7 มิถุนายน พ.ศ. 2558	28 สิงหาคม พ.ศ. 2559

More Python libraries available at API:Client code/All#Python.

R

ชื่อ	รายละเอียด	รุ่นล่าสุด	วันที่เผยแพร่	กิจกรรมสุดท้าย
WikipediR	A wrapper for the MediaWiki API, aimed particularly at the Wikimedia 'production' wikis, such as Wikipedia. Can be used to retrieve page text, information about users or the history of pages, and elements of the category tree.	1.5.0	15 กุมภาพันธ์ พ.ศ. 2560	15 กุมภาพันธ์ พ.ศ. 2560

Ruby

ชื่อ	รายละเอียด	รุ่นล่าสุด	วันที่เผยแพร่	กิจกรรมสุดท้าย
MediaWiki::Butt	Stable and powerful Ruby framework for the API. (Evaluation)	3.0.0	19 ตุลาคม พ.ศ. 2560	3 มกราคม พ.ศ. 2562
wikipedia-client	Ruby framework using the API.	v1.10.0	5 มีนาคม พ.ศ. 2561	5 มีนาคม พ.ศ. 2561
MediaWiki Ruby API	Ruby API client library in active development by Wikimedia Foundation Release Engineering.	0.71	31 มกราคม พ.ศ. 2560	5 ธันวาคม พ.ศ. 2560

More Ruby libraries available at API:Client code/All#Ruby.

Rust

ชื่อ	รายละเอียด	รุ่นล่าสุด	วันที่เผยแพร่	กิจกรรมสุดท้าย
Wikibase RS	Rust library to talk to the Wikibase API and serialize data into Rust data structures.	0.37	19 มิถุนายน พ.ศ. 2562	19 มิถุนายน พ.ศ. 2562
mediawiki_rust	A MediaWiki client library in Rust.			16 พฤศจิกายน พ.ศ. 2563
mwbot-rs	A framework for writing bots on MediaWiki	0.4.3	15 ตุลาคม พ.ศ. 2565	5 พฤศจิกายน พ.ศ. 2565
wiki	Library for interacting with MediaWiki APIs	0.0.3	10 สิงหาคม พ.ศ. 2565	5 พฤศจิกายน พ.ศ. 2565

More Rust libraries available at API:Client code/All#Rust.

Scala

ชื่อ	รายละเอียด	รุ่นล่าสุด	วันที่เผยแพร่	กิจกรรมสุดท้าย
scalawiki	MediaWiki client in Scala.	0.6.3	17 กันยายน พ.ศ. 2563	28 กันยายน พ.ศ. 2562
dbpedia extraction framework	Data extraction framework for DBpedia with support Wiki source retrieved via MediaWiki API.	DBpedia_2015-10	25 กรกฎาคม พ.ศ. 2559	13 เมษายน พ.ศ. 2562
scmw	Simple MediaWiki API wrapper for needs of Commonist image upload tool.	v-0.140.0	22 ธันวาคม พ.ศ. 2560	22 ธันวาคม พ.ศ. 2560

ดูเพิ่ม

• API:Client code/All — All known API client libraries.
• 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.