Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wikimedia/mediawiki-api-demos
Demo apps and code snippets in Python, Javascript and PHP demonstrating how to use various modules of the MediaWiki Action API
https://github.com/wikimedia/mediawiki-api-demos
code-snipets demo-apps mediawiki mediawiki-api web-apis
Last synced: 6 days ago
JSON representation
Demo apps and code snippets in Python, Javascript and PHP demonstrating how to use various modules of the MediaWiki Action API
- Host: GitHub
- URL: https://github.com/wikimedia/mediawiki-api-demos
- Owner: wikimedia
- License: mit
- Created: 2018-07-08T20:57:06.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-04T13:23:38.000Z (8 months ago)
- Last Synced: 2025-01-13T11:09:27.258Z (14 days ago)
- Topics: code-snipets, demo-apps, mediawiki, mediawiki-api, web-apis
- Language: JavaScript
- Homepage:
- Size: 7.78 MB
- Stars: 169
- Watchers: 19
- Forks: 85
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# MediaWiki API Demos
The [MediaWiki Action API](https://www.mediawiki.org/wiki/API:Main_page) is a web service that allows access to some wiki-features like authentication, page operations, and search. It can provide meta information about the wiki and the logged-in user. This repository contains code snippets and demo apps in various programming languages to assist developers for easy use of various modules of the API.
> :information_source: **View a showcase of interactive demo apps built using the API on Wikimedia Toolforge: https://tools.wmflabs.org/apps-gallery/**
### Code snippets
* [Python](python/)
* [Javascript](javascript/)
* [PHP](php/)
* [MediaWikiJS](mediawikijs/)
### Demo apps
* [Holidays viewer](apps/holidays-viewer):
Demo app that fetches the holidays for a given date from Wikipedia, with an option to login to add new holidays. The app uses [API:Parse](https://www.mediawiki.org/wiki/API:Parse) to fetch the holidays and [API:Edit](https://www.mediawiki.org/wiki/API:Edit) to add a new holiday.
* [Nearby places viewer](apps/nearby-places-viewer):
Demo of geo search for wiki pages near a location using the [Geolocation API](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation_API) and MediaWiki Action API's [Geosearch](https://www.mediawiki.org/wiki/API:Geosearch) module.
* [Picture of the day viewer](apps/picture-of-the-day-viewer):
Demo app that uses [prop=images](https://www.mediawiki.org/wiki/API:Images) module to fetch Wikipedia's Picture of the Day (POTD) from a template page and displays it on a webpage. The app also allows users to go backward or forward a date to view other POTD.
* [User contributions feed](apps/user-contributions-feed):
Demo app that uses [list=usercontribs](https://www.mediawiki.org/wiki/API:Usercontribs) module to fetch the top 50 edits made by a user.
* [View more demo apps](apps/)
### Installation
```
$ git clone https://github.com/wikimedia/mediawiki-api-demos.git
$ cd mediawiki-api-demos
For running python code samples:
$ cd python
$ python3 filename.py
Note: Install any necessary python modules with pip and enter any credentials
required in the file to run the sample code
For running javascript code samples:
$ cd javascript
$ node filename.js
Note: Install any necessary node modules with npm and enter any credentials required
in the file to run the sample code
For running php code samples:
$ cd php
$ php filename.php
Note: Install necessary modules by `apt-get install php-cli php-curl` and enter any credentials
required in the file to run the sample code
```