Extension:ApiSandbox

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual - list
Crystal Clear action run.png
ApiSandbox

Release status: stable

ApiSandbox.PNG
Implementation Special page
Description MediaWiki API playground
Author(s) Max Semenik (MaxSemtalk)
MediaWiki 1.18 (r87334 or later)
License WTFPL 2.0
Download
Example Special:ApiSandbox
Hooks used
APIGetDescription

Translate the ApiSandbox extension if possible

Check usage and version matrix; code metrics

ApiSandbox allows developers using the MediaWiki API to experiment with the API from the browser. It is based on a GSoC proposal by Salil P. A..

Usage[edit | edit source]

On a wiki with ApiSandbox installed, go to Special:ApiSandbox. Choose action, format and other parameters. The sandbox displays interactive help for every request parameter. Once all parameters are set, click on "Make request" button. The result will be displayed below in the format you chose. The request URL (and POST data, if needed) can be copy-pasted for reuse.

Installation[edit | edit source]

  1. Download the files from Git and place them in $IP/extensions/ApiSandbox/
  2. Add
    require_once("$IP/extensions/ApiSandbox/ApiSandbox.php");
    into your wiki's LocalSettings.php


Usage[edit | edit source]

Navigate to Special:ApiSandbox