https://github.com/barcellos-pedro/spring-rest-service
Building REST services with Spring
https://github.com/barcellos-pedro/spring-rest-service
hateoas hypermedia-api java rest spring-boot
Last synced: 7 months ago
JSON representation
Building REST services with Spring
- Host: GitHub
- URL: https://github.com/barcellos-pedro/spring-rest-service
- Owner: barcellos-pedro
- Created: 2024-01-26T00:56:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-14T22:42:56.000Z (over 1 year ago)
- Last Synced: 2025-01-30T00:15:56.642Z (8 months ago)
- Topics: hateoas, hypermedia-api, java, rest, spring-boot
- Language: Java
- Homepage: https://spring.io/guides/tutorials/rest/
- Size: 129 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Building REST services with Spring
Project based on [Spring Guide](https://spring.io/guides/tutorials/rest/)
## Up & Running
In your terminal run: `docker compose up --build -d`
## Roadmap
- Refactor (Project Structure)
- [x] Controller
- [x] Model
- [x] Interface
- [x] Etc...
- [x] [Metrics and Tracing](https://spring.io/guides/gs/tanzu-observability/)
- [x] [Dockerfile](https://spring.io/guides/topicals/spring-boot-docker/)
### Todo
For the sake of simplicity, only the Employee model has tests
- [Tests](https://docs.spring.io/spring-boot/docs/3.2.2/reference/html/features.html#features.testing)
- [x] [JSON](https://spring.academy/courses/building-a-rest-api-with-spring-boot)
- [x] Unit
- [x] Integration
- [x] [WebMvc](https://spring.io/guides/gs/testing-web/)
- [CI/CD GitHub Actions](https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven)
- [x] Build
- [x] Test
### Bônus 🎁
- [x] Replace H2 for [Postgres](https://www.docker.com/blog/how-to-use-the-postgres-docker-official-image/)
- [x] [Monitor Postgres with PGAdmin](https://github.com/docker/awesome-compose/tree/master/postgresql-pgadmin)
- [x] [Caching (Redis)](https://docs.spring.io/spring-framework/reference/integration/cache/annotations.html)
- [x] [Docker Compose](https://github.com/docker/awesome-compose/tree/master/spring-postgres)
- [x] [Nginx](https://github.com/docker/awesome-compose/tree/master)
- [x] [Performance Test (Jmeter)](https://jmeter.apache.org/index.html)
- [ ] [API Docs with Restdocs](https://spring.io/guides/gs/testing-restdocs/)
### Jmeter Tests Formula
Total of requests = `number of threads * loop count`
Requests per second = `number of threads / ramp-up period`