FAIRware Workbench API

Build status

Master	Develop

Introduction

This repository contains the code corresponding to the API layer of the FAIRware Workbench.

The FAIRware Workbench is a tool to evaluate metadata for digital research objects based on the FAIR principles. This tool will provide researchers with actionable advice on how to improve the quality of the metadata used to annotate the digital research objects under consideration.

For more information about the FAIRware initiative and the FAIRware Workbench, take a look at this press release from the Research on Research Institute (RoRI).

The following diagram shows the architecture of the FAIRware Workbench. The code in the current repository corresponds to the Open APIs and Backend services layers, highlighted in red.

How to start the FAIRware Workbench API application

1. The FAIRware Workbench takes advantage of some of the metadata services provided by the CEDAR system. If you don't have a CEDAR account yet, create one at https://cedar.metadatacenter.org/ and copy your CEDAR API key from the CEDAR profile page.
2. Rename config-example.yml to config.yml and enter your CEDAR api key as the value of cedar.apiKey. Example:

   ...
   
   cedar:
     apiKey: 'ae7a5d2bf6254707b3d9c51822e5ef49c528428791c3e2f84b9e75532326e74b'
   
   ...  
   
   

3. Run mvn clean install to build your application
4. Start application with java -jar target/fairware-workbench-api-0.1.0-SNAPSHOT.jar server config.yml
5. To check that your application is running enter, chech the API documentation at http://localhost:9090/swagger

Health Check

To see your applications health enter url http://localhost:9091/healthcheck