Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/timtwiest/simple-java-api
A simple Java API written with Spring Boot and OpenAPI
https://github.com/timtwiest/simple-java-api
cucumber docker jacoco java junit5 maven openapi postgresql spring-boot
Last synced: 28 days ago
JSON representation
A simple Java API written with Spring Boot and OpenAPI
- Host: GitHub
- URL: https://github.com/timtwiest/simple-java-api
- Owner: timtwiest
- License: mit
- Created: 2024-03-20T16:01:13.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-04-21T20:38:45.000Z (7 months ago)
- Last Synced: 2024-09-28T11:40:54.851Z (about 1 month ago)
- Topics: cucumber, docker, jacoco, java, junit5, maven, openapi, postgresql, spring-boot
- Language: Java
- Homepage:
- Size: 38.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# simple-java-api
## Table of Contents
1. [Requirements](#requirements)
2. [Getting Started](#getting-started)
3. [Containerization](#containerization)
4. [OpenAPI](#openapi)
5. [Roadmap](#roadmap)
6. [Contributing](#contributing)
## Requirements
- Java 21 Temurin
- Apache Maven 3.6.3 or higher
- PostgreSQL 9.6 or higher
- Docker 20.10.21 or higher
- Docker Compose 2.13.0 or higher
## Getting Started
### Clone the Repository
Clone the repository to your local machine:
```bash
git clone [email protected]:timtwiest/simple-java-api.git
```
### Run the PostgreSQL Database
Start the PostgreSQL database using Docker Compose:
```bash
docker-compose up -d postgres-db
```
### Build the Project
Build the project using Maven:
```bash
mvn clean install
```
## Containerization
This application is designed to be containerized using Docker. This allows the Spring Boot application to run in a
reproducible environment.
### Creating a Docker Image
Create a Docker image of the application:
```bash
docker build -t simple-java-api .
```
### Starting the Application
Use the provided `docker-compose.yaml` to start both the PostgreSQL instance and the application:
```bash
docker-compose up -d
```
## OpenAPI
The application features an OpenAPI interface for easy interaction with the API. It provides a user-friendly way to view
and test the endpoints.
You can access the OpenAPI-interface locally at http://localhost:9080/api/ui.
## Roadmap
_coming soon_
## Contributing
_coming soon_