MaDgIK
/
openaire-search-api-v2
13
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity
31 Commits 8 Branches 0 Tags 631 KiB
Java 99.7%
Dockerfile 0.3%
Go to file
Serafeim Chatzopoulos 1089f68d91 Return BadRequest when unknown parameters are given 2024-06-04 18:08:41 +03:00
.mvn/wrapper Initial commit: SolrJ client createad; OpenAPI UI init 2024-02-29 17:51:01 +02:00
src Return BadRequest when unknown parameters are given 2024-06-04 18:08:41 +03:00
.env Add docker support (Dockerfile && docker-compose.yml) 2024-03-04 15:55:03 +02:00
.gitignore Add basic README file 2024-03-04 15:58:14 +02:00
Dockerfile Update Dockerfile to build jar file 2024-03-14 15:27:53 +02:00
README.md Add real-time-get support for projects; Time request using interceptor 2024-03-04 19:00:49 +02:00
docker-compose.yml Add docker support (Dockerfile && docker-compose.yml) 2024-03-04 15:55:03 +02:00
mvnw Initial commit: SolrJ client createad; OpenAPI UI init 2024-02-29 17:51:01 +02:00
mvnw.cmd Initial commit: SolrJ client createad; OpenAPI UI init 2024-02-29 17:51:01 +02:00
pom.xml Uprgade spring-boot-starter-parent to v3.3.0 2024-06-04 14:30:18 +03:00

README.md

OpenAIRE Search API v2

Welcome to the OpenAIRE Search API v2 code repository!

This repository houses the latest implementation of our OpenAIRE Search API, designed to facilitate seamless access to metadata records of research products (i.e., publications, data, software, other research products), and projects within the OpenAIRE Graph.

For more information, please take a look at our documentation page.

Getting Started

Reference for developers

  • This project is built with Java 21; tested using OpenJDK 21.0.2.

  • Before starting the application, please load env variables from .env file. If you are using IntelliJ, you can do that by navigating to Run -> Edit Configurations -> Modify Options, check Environment variables under Operating Systems, and append the env variables with a semicolon separator.

Docker support

Create a docker image using:

# building the jar file
mvn install 

# building the actual docker image
docker build -t openaire-search-api-v2:latest .

Start a docker container as follows:

# load required env variables
source .env

# start docker container
docker run -it -p 8080:8080 openaire-search-api-v2:latest .

or using docker compose:

# adjust env variables in docker-compose.yml

# start container using docker compose 
docker compose up -d

In both case, Swagger should be accessible at ${OPENAPI_SERVER_BASE_URL}/swagger-ui/index.html#/ or http://localhost:8080/swagger-ui/index.html#/ inf you are running it on localhost.