[!IMPORTANT]
Do not merge this until #2705 is merged.
Description
Add a project for MODEL-AD REST API developed with Java-Spring and generated with the OpenAPI Generator.
The new project model-ad-api has been created by adapting the project openchallenges-challenge-service.
Features:
Modern Tech Stack: This project is configured for Java 17 and Spring Boot 2.7.8, Spring Cloud 3.1.4, and Spring Data 2.7.7.
Code Formatting: Using Spotless ensures consistent code formatting, improving readability and maintainability.
Testing: JUnit 5 for unit and integration tests along with JaCoCo for code coverage shows a focus on code quality and testability.
Static Code Analysis (upcoming): Future integration of Sonar will enable detection of bugs, code smells, and security vulnerabilities along with tracking code coverage.
Containerization and Security: Containerizing the REST API with Docker allows for easy deployment and potential for scaling. Trivy helps identify security vulnerabilities in the container image.
Image Publishing: Publishing the image to GHCR (GitHub Container Registry) provides a secure and reliable way to store and access the image.
Changelog
add the project model-ad-api
add an implementation for the single endpoint of the API (static response)
Preview
Start the REST API development server
nx serve model-ad-api
Open your browser and navigate to localhost:8080 to access the Swagger UI of the API.
Fetch a page of genes from Swagger UI:
Build the image of the REST API
nx build-image model-ad-api
Start the REST API server (Docker container)
nx serve-detach model-ad-api
Open your browser and navigate to localhost:8080 to access the Swagger UI of the API.
Description
Add a project for MODEL-AD REST API developed with Java-Spring and generated with the OpenAPI Generator.
The new project
model-ad-api
has been created by adapting the projectopenchallenges-challenge-service
.Features:
Changelog
model-ad-api
Preview
Start the REST API development server
Open your browser and navigate to
localhost:8080
to access the Swagger UI of the API.Fetch a page of genes from Swagger UI:
Build the image of the REST API
Start the REST API server (Docker container)
Open your browser and navigate to
localhost:8080
to access the Swagger UI of the API.