API: Código de cliente

Esta página faz parte da documentação da API de Ação do MediaWiki.

As bibliotecas de cliente contêm código que os programadores podem utilizar para ajudar com as tarefas comuns e básicas, de maneira que não tenham que escrever o código desde o zero quando os seus projetos interagem com uma API.

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

Nome	Descrição	Último lançamento	Data de lançamento	Última atividade
BotWikiAwk	Estrutura e bibliotecas para criar robôs. Inclui robôs de exemplo.			27 de março de 2019
Wikiget	Awk CLI program to interface with MediaWiki API for read/write including OAuth.			8 de junho de 2019

Nome	Descrição	Último lançamento	Data de lançamento	Última atividade
bash-mediawiki	An example with Curl that allows easy editing/uploading of a wiki through the MediaWiki API.			17 de agosto de 2021

Nome	Descrição	Último lançamento	Data de lançamento	Última atividade
libmediawiki	A library that allows easy editing of a wiki through the MediaWiki API.			9 de setembro de 2017

Nome	Descrição	Último lançamento	Data de lançamento	Última atividade
cl-mediawiki	A Common Lisp wrapper for the MediaWiki API.			10 de novembro de 2016

Nome	Descrição	Last release	Data de Lançamento	Última atividade
mediawiki_client_ex	Adapter for the Action API, EventStreams, and ORES. (Documentação)	0.5.3	20 de dezembro de 2022	20 de abril de 2025

Nome	Descrição	Último lançamento	Data de lançamento	Última atividade
go-mediawiki	Go wrapper for the MediaWiki API.	v0.1	4 de novembro de 2013	8 de fevereiro de 2017
go-mwclient	Wrapper for the MediaWiki API (supports maxlag, query continuations, OAuth).	v1.2.0	3 de junho de 2020	3 de junho de 2020

Nome	Descrição	Último lançamento	Data de lançamento	Última atividade
haskell mediawiki	A complete Haskell binding to the MediaWiki API letting you programmatically access (read and write) MediaWiki content.	0.2.6	20 de novembro de 2013	20 de novembro de 2013

Nome	Descrição	Último lançamento	Data de lançamento	Última atividade
JavaWikiBotFramework	A library to retrieve data from and maintain MediaWiki-based wikis such as Wikipedia.	4.0.0	13 de setembro de 2016	15 de fevereiro de 2019
jwiki	A library for effortlessly interacting with Wikipedia/MediaWiki.	1.8.0	14 de abril de 2020	6 de maio de 2020
Bliki Engine	Can convert wikicode to HTML, DocBook or PDF. Has a helper library for API calls.			27 de abril de 2019

More Java libraries available at API:Client_code/All#Java.

Name	Description	Last release	Release date	Last activity
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	30 de setembro de 2023	31 de março de 2025
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	5 de maio de 2025	18 de maio de 2025
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	30 de outubro de 2017	17 de dezembro de 2022
nodemw (Node.js)	A generic MediaWiki API client for Node.js.	v0.24.1	16 de setembro de 2018	3 de maio de 2025
wikiapi (Node.js)	A simple way to access MediaWiki API via JavaScript with simple wikitext parser.	v1.20.0	1 de outubro de 2020	6 de fevereiro de 2024
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:

Name	Description	Last release	Release date	Last activity
mwapilib2	A layer overtop of the requests. Make JS gadgets easier.			25 de setembro de 2016
JsMwApi	A convenience wrapper around raw requests, with some helpers for editing and parsing.			11 de junho de 2014

More JavaScript libraries available at API:Client_code/All#JavaScript.

Name	Description	Last release	Release date	Last activity
dtMediaWiki	Extension for Darktable. 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.			12 de junho de 2025

Name	Description	Last release	Release date	Last activity
MatWiki	A preliminary (as of Feb 2019) MATLAB R2016b(9.1.x) client supporting just bot-logins & semantic #ask queries.	v1.0.0	19 de fevereiro de 2019	19 de fevereiro de 2019

Name	Description	Last release	Release date	Last activity
WikiFunctions	Library with classes for editing and getting lists of pages via the API, used by AutoWikiBrowser.	6.4.0.0	19 de fevereiro de 2025	14 de agosto de 2025
LinqToWiki	Strongly typed library for accessing most of MediaWiki API, with support for autocompletion.	1.5.0	7 de maio de 2015	7 de maio de 2015
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 de janeiro de 2021	5 de novembro de 2022

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

Name	Description	Last release	Release date	Last activity
ocaml-mediawiki	A high-level binding for the MediaWiki API written in OCaml.			29 de agosto de 2012

Name	Description	Last release	Release date	Last activity
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 de julho de 2016	7 de julho de 2016
MediaWiki::API	A Perl module for interfacing with the MediaWiki API with file upload/download and editing support. (Debian package). (Evaluation).	0.41	13 de novembro de 2015	13 de novembro de 2015

Name	Description	Last release	Release date	Last activity
mediawiki-api-base	Library for basic MediaWiki api use.	2.4.0	2 de novembro de 2017	9 de julho de 2019
mediawiki-api	A simple library for interacting with the MediaWiki API.	0.7.2	20 de novembro de 2017	6 de abril de 2019
wikibase-api	Library for querying Wikidata.	0.7	4 de julho de 2016	17 de agosto de 2018

More PHP libraries available at API:Client code/All#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.

Name	Type hints	Description	Last release	Release date	Last activity
Pywikibot docs	Yes	A collection of Python scripts and a powerful library for bot writing. (PyPI) (Git repository) (#pywikibot connect) (Evaluation).	10.7.6	318 de janeiro de 2026	fevereiro de 2026
pwiki docs	Yes	A Python library for developing bots/tools, focused on ease of use and simplicity.	1.1.1	15 de outubro de 2021	28 de maio de 2022
mwclient docs	No	Python library that makes most of the API functions accessible. (PyPI) (Evaluation).	0.10.1	28 de maio de 2020	26 de setembro de 2021
wiki-scripts docs	No	Framework for writing bots, maintenance scripts or performing data analysis.	1.2	31 de dezembro de 2017	13 de junho de 2019

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

Name	Type hints	Description	Last release	Release date	Last activity
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 de abril de 2019	13 de abril de 2019
Wikipedia docs	No	A Python library that makes it easy to access and parse data from Wikipedia.	v1.1	24 de dezembro de 2013	11 de novembro de 2016
wikitools	No	Provides several layers of abstraction around the API. Doesn't support Python 3.	0.41	7 de junho de 2015	28 de agosto de 2016

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

Name	Description	Last release	Release date	Last activity
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 de fevereiro de 2017	15 de fevereiro de 2017

Name	Description	Last release	Release date	Last activity
MediaWiki::Butt	Stable and powerful Ruby framework for the API. (Evaluation)	3.0.0	19 de outubro de 2017	3 de janeiro de 2019
wikipedia-client	Ruby framework using the API.	v1.10.0	5 de março de 2018	5 de março de 2018
MediaWiki Ruby API	Ruby API client library in active development by Wikimedia Foundation Release Engineering.	0.71	31 de janeiro de 2017	5 de dezembro de 2017

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

Name	Description	Last release	Release date	Last activity
Wikibase RS	Rust library to talk to the Wikibase API and serialize data into Rust data structures.	0.37	19 de junho de 2019	19 de junho de 2019
mediawiki_rust	A MediaWiki client library in Rust.			16 de novembro de 2020
mwbot-rs	A framework for writing bots on MediaWiki	0.4.3	15 de outubro de 2022	5 de novembro de 2022
wiki	Library for interacting with MediaWiki APIs	0.0.3	10 de agosto de 2022	5 de novembro de 2022
mediawiki_rest_api	Library for interacting with the MediaWiki REST API	0.0.1	21 de outubro de 2025	21 de outubro de 2025

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

Name	Description	Last release	Release date	Last activity
scalawiki	MediaWiki client in Scala.	0.6.3	17 de setembro de 2020	28 de setembro de 2019
dbpedia extraction framework	Data extraction framework for DBpedia with support Wiki source retrieved via MediaWiki API.	DBpedia_2015-10	25 de julho de 2016	13 de abril de 2019
scmw	Simple MediaWiki API wrapper for needs of Commonist image upload tool.	v-0.140.0	22 de dezembro de 2017	22 de dezembro de 2017

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