addwiki/mediawiki-api-base

Simple MediaWiki API library

Maintainers

Details

github.com/addwiki/mediawiki-api-base

Source

Installs: 141 137

Dependents: 11

Suggesters: 0

Security: 0

Stars: 36

Watchers: 9

Forks: 22

3.1.0 2024-10-15 20:46 UTC

Requires

Requires (Dev)

Suggests

  • ext-dom: Needed if you want to discover APIs using only page URLs
  • ext-simplexml: Needed if you want to discover APIs using only page URLs

GPL-2.0-or-later 9a7433eb94284d9625c4c57de0bd1d45a6e301f4

  • Addshore

apimediawiki

This package is auto-updated.

Last update: 2024-12-15 21:10:38 UTC

README

GitHub issue custom search in repo Latest Stable Version Download count

This library provides basic access to the MediaWiki Action API. This library features simple methods allowing you to login, logout and do both GET and POST requests. This library should work with most if not all MediaWiki versions due to its simplicity.

You can find the full documentation at https://addwiki.github.io/mediawiki-api-base/

Example

A quick example can be found below:

use \Addwiki\Mediawiki\Api\Client\Auth\UserAndPassword;
use \Addwiki\Mediawiki\Api\Client\Action\MediawikiApi;

$auth = new UserAndPassword( 'username', 'password' );
$api = MediawikiApi::newFromPage( 'https://en.wikipedia.org/wiki/Berlin', $auth );
$purgeRequest = FluentRequest::factory()->setAction( 'purge' )->setParam( 'titles', 'Berlin' );
$api->postRequest( $purgeRequest );

Integration tests

Run the MediaWiki test site:

docker compose -f docker-compose-ci.yml up -d

Run the tests:

composer phpunit-integration

Destroy the site that was used for testing:

docker compose -f docker-compose-ci.yml down --volumes