openaire-search-api-v2/README.md

55 lines
1.5 KiB
Markdown
Raw Normal View History

# OpenAIRE Graph API
2024-03-04 14:58:14 +01:00
Welcome to the OpenAIRE Graph API code repository!
2024-03-04 14:58:14 +01:00
This repository houses the latest implementation of our OpenAIRE Graph API,
2024-03-04 14:58:14 +01:00
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](https://graph.openaire.eu/docs/apis/graph-api/).
2024-03-04 14:58:14 +01:00
# 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.
2024-03-04 14:58:14 +01:00
### Docker support
Create a docker image using:
```shell
# building the jar file
mvn install
# building the actual docker image
docker build -t openaire-graph-api:latest .
2024-03-04 14:58:14 +01:00
```
Start a docker container as follows:
```shell
# load required env variables
source .env
# start docker container
docker run -it -p 8080:8080 openaire-graph-api:latest .
2024-03-04 14:58:14 +01:00
```
or using docker compose:
```shell
# 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.
2024-03-04 14:58:14 +01:00