/listing-api

API for NDLA "show and filter" service

Primary LanguageScalaGNU General Public License v3.0GPL-3.0

listing-api

Build Status

Usage

API for NDLAs "show and filter" service for e.g. an overview of articles. Creates, updates and returns a cover, a short summary representation of an article's metadata. Is currently only used by the frontend Utlisting, which only gets and displays the data. It is possible to add new or update covers through the use of this API, as of now this is not implementet by any service except the original/one-off data import script.

To interact with the api, you need valid security credentials; see Access Tokens usage. To write data to the api, you need write role access.

For a more detailed documentation of the API, please refer to the API documentation (Staging: API documentation).

Developer documentation

Compile: sbt compile

Run tests: sbt test

Create Docker Image:./build.sh