Install curl, fileinfo, intl and mbstring for PHP. Put this in your composer.local.json:
{
"require": {
"noris/jsoner": "~1.0"
}
}
and run composer update. Then, append this to your LocalSettings.php:
wfLoadExtension( 'Jsoner' );
$jsonerBaseUrl = 'https://example.com/api/';
$jsonerUser = '<your_user>';
$jsonerPass = '<your_pass>';
This is a MediaWiki extension that allows one to embed external JSON data (i.e. from a REST API) into an article.
This extension requires at least PHP >= 5.6 and the following PHP extensions:
- curl
- fileinfo
- intl
- mbstring
Using Debian / Ubuntu you can install the extensions like this:
sudo apt-get install php5-curl php5-intl
sudo service apache2 restart
To test if they are enabled (use your php.ini):
$ php5 --php-ini /etc/php5/apache2/php.ini -m | grep -E 'fileinfo|mbstring|intl|curl'
curl
fileinfo
intl
mbstring
Put this to your composer.local.json:
{
"require": {
"noris/jsoner": "~1.0"
}
}
and run composer update (or composer install if you don't have a composer.lock yet).
Download the extension and put it in your extension/ folder.
To enable this extension, add this to your LocalSettings.php:
wfLoadExtension( 'Jsoner' );
This will enable the Jsoner extension and add the following functions to the MediaWiki parser:
#jsonerwith parametersurland filters, see below.
The extension has multiple settings. Please put them after the wfLoadExtension( 'Jsoner' );.
$jsonerBaseUrl = 'https://example.com/api/';
This can be used to prefix all #jsoner calls (the url argument specifically) with this url
so that you don't have to repeat yourself, if you only consume data from one domain. If omitted,
you have to provide complete domains in url.
$jsonerUser = '<your_user>';
$jsonerPass = '<your_pass>';
If both are set, this is passed to cURL to authenticate. If omitted, cURL tries unauthenticated.
Jsoner has a pipes and filters architecture. First, data is fetched, then filters are applied and finally, the data is transformed in a representation.
Fetch → [Filter ...] → Transformer
This looks like this in MediaWiki syntax:
// Fetch → Filter → Filter → Transformer
{{ #jsoner:url=… | f-SelectSubtree=foo | f-SelectKeys=name,email | t-JsonDump }}
Lets run something interesting:
{{ #jsoner:url=http://pokeapi.co/api/v2/pokemon/1/ | f-SelectSubtree=stats | t-JsonDump }}
↓
[
{
"base_stat": 45,
"effort": 0,
"stat": {
"name": "speed",
"url": "http://pokeapi.co/api/v2/stat/6/"
}
},
{
"base_stat": 65,
"effort": 0,
"stat": {
"name": "special-defense",
"url": "http://pokeapi.co/api/v2/stat/5/"
}
},
{
"base_stat": 65,
"effort": 1,
"stat": {
"name": "special-attack",
"url": "http://pokeapi.co/api/v2/stat/4/"
}
},
{
"base_stat": 49,
"effort": 0,
"stat": {
"name": "defense",
"url": "http://pokeapi.co/api/v2/stat/3/"
}
},
{
"base_stat": 49,
"effort": 0,
"stat": {
"name": "attack",
"url": "http://pokeapi.co/api/v2/stat/2/"
}
},
{
"base_stat": 45,
"effort": 0,
"stat": {
"name": "hp",
"url": "http://pokeapi.co/api/v2/stat/1/"
}
}
]
As you can see, Filters are prefixed with f- and Transformers are prefixed with t-.
A typical call looks like this
{{ #jsoner:url=… | f-SelectSubtree=foo | }}
Runs on a list and returns a list. Usage: f-CensorKeys=key(,key)*,replacement
Example: f-CensorKeys=email,--protected--
[
{
"name": "Bob",
"email": "[email protected]"
},
{
"name": "Tom",
"email": "[email protected]"
}
]
↓
[
{
"name": "Bob",
"email": "--protected--"
},
{
"name": "Tom",
"email": "--protected--"
}
]
Runs on a list and returns a list. Usage: f-Reduce=(\w+),(\w+)(\.\w+)*
Example: f-Reduce=mail,data.email
[
{
"id": "1",
"data": {
"email": "[email protected]",
"city": "Berlin"
}
},
{
"id": 2,
"data": {
"email": "[email protected]",
"city": "Hamburg"
}
}
]
↓
[
{
"id": "1",
"data": {
"email": "[email protected]",
"city": "Berlin"
},
"mail": "[email protected]"
},
{
"id": 2,
"data": {
"email": "[email protected]",
"city": "Hamburg"
},
"mail": "[email protected]"
}
]
Runs on a list and returns a list. Usage: f-RemoveKeys=key(,key)*
Example: f-RemoveKeys=email
[
{
"name": "Bob",
"email": "[email protected]"
},
{
"name": "Tom",
"email": "[email protected]"
}
]
↓
[
{
"name": "Bob"
},
{
"name": "Tom"
}
]
Runs on a list and returns a list. Usage: f-SelectKeys=key(,key)*
Example: f-SelectKeys=email
[
{
"name": "Bob",
"email": "[email protected]"
},
{
"name": "Tom",
"email": "[email protected]"
}
]
↓
[
{
"email": "[email protected]"
},
{
"email": "[email protected]"
}
]
Runs on an object and returns a list. Usage: f-SelectSubtree=key
Example: f-SelectSubtree=records
{
"recordCount": 2,
"records": [
{
"name": "Bob",
"email": "[email protected]"
},
{
"name": "Tom",
"email": "[email protected]"
}
]
}
↓
[
{
"name": "Bob",
"email": "[email protected]"
},
{
"name": "Tom",
"email": "[email protected]"
}
]
Runs on a list and returns a list. Usage: [f-SelectRecord=key:value]
Example: f-SelectRecord=email:[email protected]
[
{
"name": "Bob",
"email": "[email protected]"
},
{
"name": "Tom",
"email": "[email protected]"
}
]
↓
[
{
"name": "Tom",
"email": "[email protected]"
}
]
There must be always a transformer at the end of the pipeline.
Creates a comma-separated list of values from a list.
Usage: t-InlineList=key
With a list as input, calling t-InlineList=email
[
{
"name": "Bob",
"email": "[email protected]"
},
{
"name": "Tom",
"email": "[email protected]"
}
]
↓
[email protected], [email protected]
Good for, you guessed it: lists!
Dumps the JSON data into a <pre> tag. Nice for debugging.
Returns a single JSON value out of an object or a list. If the input is a list, the SingleElementTransformer will use the first element in the list to display something.
Usage: t-SingleElement=key
With a list as input, calling t-SingleElement=name
[
{
"name": "Bob",
"email": "[email protected]"
},
{
"name": "Tom",
"email": "[email protected]"
}
]
↓
Bob
With an object as input, calling t-SingleElement=name
{
"name": "Bob",
"email": "[email protected]"
}
↓
Bob
Nice for single values like IDs.
Creates a <br /> separated (on top of each other) stack out of an object or a list. If the input
is a list, the StackedElementTransformer uses the first element in the list and displays that.
With a list as input:
[
{
"name": "Bob",
"email": "[email protected]"
},
{
"name": "Tom",
"email": "[email protected]"
}
]
↓
Bob
[email protected]
With an object as input:
{
"name": "Tom",
"email": "[email protected]"
}
↓
Tom
[email protected]
Useful for address data.
Creates a nice and sortable Wikitext table out of a list of objects.
[
{
"name": "Bob",
"email": "[email protected]"
},
{
"name": "Tom",
"email": "[email protected]"
}
]
↓
╔════════╦═════════════════╗
║ name ▼ ║ email ▼ ║
╠════════╬═════════════════╣
║ Bob ║ [email protected] ║
║ Tom ║ [email protected] ║
╚════════╩═════════════════╝
Creates Wikitext depending on the given template. You probably have to create a suiting template for the query. Uses key=value pairs.
Wiki-String: {{ template |key=value }}
Usage: t-mwTemplate=template
With t-mwTemplate=jsoner-template
[
{
"name": "Bob",
"email": "[email protected]"
"username": "bobexample"
},
{
"name": "Tom",
"email": "[email protected]"
"username": "tomexample"
}
]
↓
╔════════╦═════════════════╦══════════════╗
║ name ▼ ║ email ▼ ║username ▼ ║
╠════════╬═════════════════╣══════════════╣
║ Bob ║ [email protected] ║ bobexample ║
║ Tom ║ [email protected] ║ tomexample ║
╚════════╩═════════════════╩══════════════╝
The output is depending on the template you use.
Creates Wikitext depending on the given template. You probably have to create a suiting template for the query. Doesn't use key=value pairs, uses the Anonymous templating in the Mediawiki. Template in this use case : template= {{{1}}} {{{2}}}
Usage: t-mwTemplateAnonymous=template
[
{
"name": "Bob",
"email": "[email protected]"
"username": "bobexample"
},
{
"name": "Tom",
"email": "[email protected]"
"username": "tomexample"
}
]
↓
Bob [email protected] Tom [email protected]
The output is depending on the template you use.
- If you set
$jsonerUserand$jsonerPass, the authentification is used for every request. There is currently no per-domain or per-request level setting for username and password (and maybe rightfully so). One possibility would be to put a separate call, like{{ #jsoner-unauth:url=… }}or something like that.
This extension is under development. Anything may change.
You can clone is using
git clone [email protected]:noris-network/Jsoner.git && cd Jsoner
make devenv
To install it into your development MediaWiki, just symlink it to your extensions folder
# Assuming you are in Jsoner folder
cd /path/to/your/extensions/folder
ln -s /path/to/the/Jsoner/extension Jsoner
Then, install it like described above.
To see what you can do run one of
make
make help
To test, you can run
make test
To fix warnings etc. from make test, you can run:
make fix
To clean, you can run
make clean
GPL v3