Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juarce/java-api-template
Template for a Java API, using Spring Boot, Spring Data JPA, Spring Security, and JWT.
https://github.com/juarce/java-api-template
api-rest java spring spring-boot spring-security
Last synced: 4 days ago
JSON representation
Template for a Java API, using Spring Boot, Spring Data JPA, Spring Security, and JWT.
- Host: GitHub
- URL: https://github.com/juarce/java-api-template
- Owner: JuArce
- Created: 2023-08-10T20:06:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-16T19:22:39.000Z (10 months ago)
- Last Synced: 2024-01-17T03:51:47.732Z (10 months ago)
- Topics: api-rest, java, spring, spring-boot, spring-security
- Language: Java
- Homepage:
- Size: 81.1 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Java Api Template ☕
This is a template for a Java API, using Spring Boot, Spring Data JPA, Spring Security, and JWT.
The API is a simple CRUD for a User entity.
## Next Steps 🚀
- [ ] Add unit tests in the service layer
- [x] Integrate Spring Security and JWT authentication
- [x] Implement user roles
- [x] Implement ACL
- [ ] Add integration tests
- [ ] Add Dockerfile
- [ ] Add Swagger documentation
## Requirements 📋
- Java 21 :coffee:
- Maven :wrench:
- Docker :whale:
- Postgres :elephant:
# Setup 🔨
```make install``` or
```mvn clean install```
## Database Setup 💾
### Create Database Container 🐋
This API uses a postgres database. To set up the database, run the following command:
```make create_db container= user= password= database=```
Where:
- container: the name of the docker container. If not provided, the default value is 'postgres'
- user: the user to create. If not provided, the default value is 'user'
- password: the password for the user. If not provided, the default value is '123123123'
- database: the name of the database to create. If not provided, the default value is 'java_api_template'
### Run Database Container 🏹
If you want to run or re-run the database in a different container, you can use the following command:
```make run_db container=```
Where:
- container: the name of the docker container. If not provided, the default value is 'postgres'
### Stop Database Container 🛑
If you want to stop the database container, you can use the following command:
```make stop_db container=```
Where:
- container: the name of the docker container. If not provided, the default value is 'postgres'
Tests will run using an in-memory HSQL database, so there is no need to create a database for tests.
## Security Configuration 🔒
This API uses Basic and JWT authentication.
To configure the security, you need to create a file named `jwk_set.json` in the `resources` folder.
This file must contain a JWK Set, with at least one key.
You can use the online [JSON Web Key generator](https://mkjwk.org/) to generate a JWK Set: .
Or using the [Command line JSON Web Key (JWK) generator](https://connect2id.com/products/nimbus-jose-jwt/generator).
The Jwk set must be in the following format:
```json
{
"keys": [
{
"kty": "EC",
"d": "HSveA5XkSWeaJeg79AsXlghcfFAqbBNG1Ep51QKptOY",
"crv": "P-256",
"x": "Dmh5T6s69NLhGKv1nE_-gl36h9s6hvGttn5m91G9jnY",
"y": "l8C-AGgQDGR3MpRGKFQkch0GPEYliFAHTO6osrMQwZE",
"alg": "ES256"
}
]
}
```
⚠️ Make sure to do not use this key in production. It is only an example.
# Run 🏃
```make run```
```mvn spring-boot:run -pl webapp```
⚠️ `make run` will run the database container if it is not running.
# Test ✅
```make test```
```mvn test```