jams-server
v1.0.7
Published
A RESTful interface to a MongoDB backed store of JAMS format data for reproducible MIR research
Downloads
15
Readme
JAMS Ingestion Server
This is a small Node.js server that exposes a CR (as in CRUD) RESTful API for generic JAMS data, backed by MongoDB. It could (and should) be extended to provide read and update features specific to the JAMS format so that it can be deployed as a generic server for a wide variety of musicological data storage, however at the moment it's streamlined for my specific research into velocity aware trajectorial playlisting.
Usage
Install the server with npm install -g jams-server
.
Set the environmental variables "JAMS_MONGO_URI" to point at your mongodb instance, and "JAMS_PORT" to specify the port your jams server should run on.
Run jams-server
to spin up a service.
API Documentation
- GET $SERVER/jams/:id
- Returns the specific JAMS file for the specified identifier
- PUT $SERVER/jams
- Accepts JAMS formatted JSON and inserts it into the database, returns an identifier
- GET $SERVER/jams
- Returns a list of jams files