europeana / iiif-manifest-api Goto Github PK

Europeana IIIF Manifest API for IIIF v2 and v3 manifests

The Europeana IIIF Manifest API is a Java Spring-Boot 2 application that on each valid request first retrieves json data from the Europeana Record API and uses the response to generate either an IIIF v2 or v3 manifest.

The Manifest API will also check with the Europeana Full-Text API if the record has fulltext available. If that is the case then a link to the appropriate IIIF Fulltext API url is added in the manifest.

A manifest request requires an Europeana API key and takes the following form:

https://<hostname>/presentation/<collectionId>/<recordId>/manifest?wskey=<apikey>

By default an IIIF v2 will be generated, but you can specify which version you want by adding

• a format parameter, e.g. https://<hostname>/presentation/<collectionId>/<recordId>/manifest?wskey=<apikey>&format=3
• or add an accept header to your request, e.g. Accept: application/json; profile="http://iiif.io/api/presentation/3/context.json"

mvn clean install (add -DskipTests) to skip the unit tests during build

1. Generate a Docker image using the project's Dockerfile

2. Configure the application by generating a iiif.user.properties file and placing this in the k8s folder. After deployment this file will override the settings specified in the iiif.properties file located in the src/main/resources folder. The .gitignore file makes sure the .user.properties file is never committed.

3. Configure the deployment by setting the proper environment variables specified in the configuration template files in the k8s folder

4. Deploy to Kubernetes infrastructure