RESEDA API Search

Prerequisites

• git >= 2.7.0
• Node.js >= 16
• npm >= 7.20.0
• Docker
• docker-compose

Installation

$ git clone https://gitbucket.inist.fr/git/METADoRe/reseda-search.git
$ cd ./reseda-search

Production

$ docker-compose up -d api

Usage

API Key

A master API key is created at the first launch of the application, API keys are stored in ./api-keys.json file.

An API key gives access to more fields returned by the API, for examples:

{
  "scope": [],
  "fields": {
    "employees": [],
    "structures": []
  },
  "metadata": {
    "application": "",
    "tags": []
  }
}

There are one way to use an api key, by the header x-api-key.

Examples:

$ curl -H "x-api-key: 6596ae25fdfdc83b85a7" http://localhost:3000/employees

$ curl http://localhost:3000/employees?apiKey=6596ae25fdfdc83b85a7

Development

$ npm install # Install Node.JS dependencies
$ docker-compose -f docker-compose.debug.yml run --rm elastic chown -R elasticsearch /usr/share/elasticsearch/ # Chown ElasticSearch volume
$ docker-compose -f docker-compose.debug.yml up -d elastic # Run ElasticSearch
$ docker-compose -f docker-compose.debug.yml up -d api # Run API in development mode

Tests

$ npm run test

Environment variables

OpenAPI

The OpenAPI page is by default available on /docs, example: http://localhost:3000/docs. You can change the URL via the environment variable RESEDA_DOC_URL.