Extension:ApiSandbox

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

Release status: stable

2015-03-16 ApiSandbox screenshot.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
APIGetDescriptionMessages

APIHelpModifyOutput

Translate the ApiSandbox extension if it is available at translatewiki.net

Check usage and version matrix; code metrics

Issues:

Open tasks · Report a bug

ApiSandbox lets developers experiment with the MediaWiki API in a browser form. 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. Then click the "Make request" button. ApiSandbox makes the request to api.php on your behalf and displays the result below in the format you chose. You can copy the request URL (and POST data, if needed) for reuse.

You can preload ApiSandbox form parameters by putting the query string to api.php in the URL fragment, for example the query /w/api.php?action=languagesearch&search=Maratih&typos=1 becomes Special:ApiSandbox#action=languagesearch&format=json&search=Maratih&typos=1.

Note that, despite it being called a sandbox, any write requests performed with this extension will modify the wiki.

Installation[edit | edit source]

  1. Download the files from Git and place them in $IP/extensions/ApiSandbox/
  2. Add
    wfLoadExtension( 'ApiSandbox' );
    

into your wiki's LocalSettings.php

Usage[edit | edit source]

Navigate to Special:ApiSandbox