JSKOS Concept Occurrences Provider implementation
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib/GBV/Occurrences
t
.gitignore
.perltidyrc
.travis.yml
LICENSE
README.md
app.psgi
apt.txt
config.json
cpanfile
databases.json
ecosystem.config.json
start.sh

README.md

Simple JSON API to retrieve JSKOS Concept Occurrences from GBV databases.

Build Status Coverage Status

Installation

From source:

git clone https://github.com/gbv/occurrences-api.git

Requirements

Requires Perl >= 5.14.0, cpanminus and Perl packages listed in cpanfile. Perl modules should be installed indepdendently from system Perl into subdirectoy local with local::lib:

eval $(perl -Mlocal::lib=local)
cpanm --installdeps --notest .

You may first need to install system packages listed in apt.txt:

sudo xargs apt-get -y install < apt.txt

Development

plackup -Ilib -r 

Deployment

With pm2 (modify ecosystem.config.json to change port if needed):

pm2 start ecosystem.config.json

Update:

pm2 reload occurrences-api

Usage

JSKOS Occurrences API is still being defined. Supported query parameters so far:

  • member
  • scheme (use * for all)
  • database
  • threshold

Examples

  • ?member=http://rvk.uni-regensburg.de/nt/IB_1060&scheme=*&threshold=2
  • ...