Extension:ApiExplorer

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

Release status: stable

Implementation Special page
Description A Special Page for interactively exploring the documentation of the specific version of the MediaWiki API running on the MediaWiki installation where this special page is. Currently depends on the Javascript API extension maintained by Wikia.
Author(s) Sean Colombo http://seancolombo.com
Last version 1.0 (September 2011)
MediaWiki 1.18.* or greater
License No license specified
Download See below
Example API Explorer on LyricWiki

Check usage (experimental)

Contents

[edit] Purpose

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.

[edit] Dependencies

  • 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).

[edit] Future plans (where you can help)

  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.

[edit] Screenshot

The API Explorer running on a Wikia wiki
Personal tools
Namespaces

Variants
Actions
Navigation
Support
Download
Development
Communication
Print/export
Toolbox