wikimedia-content-adapter

This repository contains a service adapter for querying the Wikimedia API. The service provides the Schul-Cloud Search API interface.

Get started

After clone this repo go inside the directory and run :

npm install

To start the service on default configurations run:

npm start

The Service will listen on localhost:8080.

If you want to run it under an other port/address run:

nodejs app.js -address address-to-listen-on -port port-to-listen-on

When running without params port or address will be default

Code Example

 your.domain/v1?Q=search-value&page[limit]=12&filter[license]=pd

API Reference

Query params:

Q = query value for searching.
page[limit] = max number of result elements.
page[offset] = offset of the result elements.
filer[filterKey] = filter for the result. The filterKey must be an key of the result object.

Docker

You can install docker.

wget -O- https://get.docker.com | sh
sudo usermod -aG docker $USER

To enable that you do not need sudo to run the docker containers, log in and out.

Once you installed docker, you can create a new schulcloud/wikimedia-content-adapter container like this:

docker build -t schulcloud/wikimedia-content-adapter .

Then, you can run the container and map the http port to port 8000 (you can change this port as you wish).

docker run --rm -p 8000:8080 schulcloud/wikimedia-content-adapter

Now, you should be able to request a search:

curl -i 'http://localhost:8000/v1?Q=einstein'

License

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
 Everyone is permitted to copy and distribute verbatim copies
 of this license document, but changing it is not allowed.