API:Rsd

MediaWiki version:

≥ 1.23

GET request to export an RSD schema.

API documentation

action=rsd

(main | rsd)

• Source: MediaWiki
• License: GPL-2.0-or-later

Export an RSD (Really Simple Discovery) schema.

• https://www.mediawiki.org/wiki/Special:MyLanguage/API:Rsd

Example:

Export the RSD schema.

api.php?action=rsd [open in sandbox]

Example

GET request

GET request to export the RSD schema.

api.php?action=rsd&format=json [try in ApiSandbox]

Response

<?xml version="1.0"?>
<rsd version="1.0"
    xmlns="http://archipelago.phrasewise.com/rsd">
    <service>
        <apis>
            <api name="MediaWiki" preferred="true" apiLink="https://www.mediawiki.org/w/api.php" blogID="">
                <settings>
                    <docs xml:space="preserve">https://www.mediawiki.org/wiki/API</docs>
                    <setting name="OAuth" xml:space="preserve">false</setting>
                </settings>
            </api>
        </apis>
        <engineName xml:space="preserve">MediaWiki</engineName>
        <engineLink xml:space="preserve">https://www.mediawiki.org/</engineLink>
        <homePageLink xml:space="preserve">https://www.mediawiki.org/wiki/MediaWiki</homePageLink>
    </service>
</rsd>

Sample code

Python

#!/usr/bin/python3

"""
    rsd.py

    MediaWiki API Demos
    Demo of `Rsd` module: Get request to export an RSD schema.

    MIT License
"""

import requests

S = requests.Session()

URL = "https://en.wikipedia.org/w/api.php"

PARAMS = {
    "action": "rsd",
    "format": "json"
}

R = S.get(url=URL, params=PARAMS)
DATA = R.json()

print(DATA)

PHP

<?php
/*
    rsd.php

    MediaWiki API Demos
    Demo of `Rsd` module: Get request to export an RSD schema.

    MIT License
*/

$endPoint = "https://en.wikipedia.org/w/api.php";
$params = [
    "action" => "rsd",
    "format" => "json"
];

$url = $endPoint . "?" . http_build_query( $params );

$ch = curl_init( $url );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
$output = curl_exec( $ch );
curl_close( $ch );

$result = json_decode( $output, true );
var_dump( $result );

Javascript

/*
    rsd.js

    MediaWiki API Demos
    Demo of `Rsd` module: Get request to export an RSD schema.

    MIT License
*/

var url = "https://en.wikipedia.org/w/api.php"; 

var params = {
    action: "rsd",
    format: "json"
};

url = url + "?origin=*";
Object.keys(params).forEach(function(key){url += "&" + key + "=" + params[key];});

fetch(url)
    .then(function(response){return response.json();})
    .then(function(response) {console.log(response);})
    .catch(function(error){console.log(error);});

MediaWiki JS

/*
	rsd.js

	MediaWiki API Demos
	Demo of `Rsd` module: Get request to export an RSD schema.

	MIT License
*/

var params = {
		action: 'rsd',
		format: 'json'
	},
	api = new mw.Api();

api.get( params ).done( function ( data ) {
	console.log( data );
} );

Possible Errors

Code	Info
readapidenied	You need read permission to use this module

Additional notes

• This module cannot be used as a generator.

See also

• API:Edit - allows you to create and edit pages.