Extension:ApiExplorer

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
API Explorer

Release status:Extension status stable

ImplementationTemplate:Extension#type Special page
DescriptionTemplate:Extension#description Allows to interactively explore the documentation of the MediaWiki API
Author(s)Template:Extension#username Sean Colombo http://seancolombo.com
Latest versionTemplate:Extension#version 1.0 (September 2011)
MediaWikiTemplate:Extension#mediawiki 1.18.* or greater
LicenseTemplate:Extension#license No license specified
Download
ExampleTemplate:Extension#example API Explorer on LyricWiki

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

Check usage and version matrix.

Purpose[edit]

The purpose of this extension is to provide a friendly interface for viewing the API documentation. Eventually, this extension should be made to allow example-calls right from the same area.

Dependencies[edit]

  • Depends on the Javascript API client maintained by Wikia.
  • The API must be enabled on the wiki where this extension is running (because the extension uses the API to generate the documentation about the API).

Installation[edit]

  • Download and place the file(s) in a directory called ApiExplorer in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/ApiExplorer/ApiExplorer.php";
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Future plans (where you can help)[edit]

  1. Update the API to return example URLs
  2. Show example URLs in the results
  3. Allow example URLs to be clicked to execute the query & return the results in a small panel.
  4. Allow modification of the URLs which make example-calls so that the user can tweak them in real-time to see the effects.

Screenshot[edit]

The API Explorer running on a Wikia wiki