Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/0xtheprodev/spring-clean-example

Clean Architecture Example with Spring Framework (Java)
https://github.com/0xtheprodev/spring-clean-example

clean-architecture graphql hexagonal-architecture hibernet java java18 maven openapi openapi3 repository-pattern rest-api spring spring-boot

Last synced: 24 days ago
JSON representation

Clean Architecture Example with Spring Framework (Java)

Host: GitHub
URL: https://github.com/0xtheprodev/spring-clean-example
Owner: 0xTheProDev
License: mit
Created: 2022-07-03T14:57:09.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2022-12-13T10:59:00.000Z (about 2 years ago)
Last Synced: 2024-10-27T17:48:20.233Z (2 months ago)
Topics: clean-architecture, graphql, hexagonal-architecture, hibernet, java, java18, maven, openapi, openapi3, repository-pattern, rest-api, spring, spring-boot
Language: Java
Homepage:
Size: 103 KB
Stars: 2
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # spring-clean-example

[![Java](https://img.shields.io/badge/java-%23ED8B00.svg?style=for-the-badge&logo=java&logoColor=white)](https://www.java.com/)

[![Spring](https://img.shields.io/badge/spring-%236DB33F.svg?style=for-the-badge&logo=spring&logoColor=white)](https://spring.io/)

[![Apache Tomcat](https://img.shields.io/badge/apache%20tomcat-%23F8DC75.svg?style=for-the-badge&logo=apache-tomcat&logoColor=black)](https://tomcat.apache.org/)

[![OpenAPI](https://img.shields.io/badge/openapi-6BA539?style=for-the-badge&logo=openapi-initiative&logoColor=fff)](https://www.openapis.org/)

[![GraphQL](https://img.shields.io/badge/-GraphQL-E10098?style=for-the-badge&logo=graphql&logoColor=white)](https://graphql.org/)

[![Open Issues](https://img.shields.io/github/issues-raw/0xTheProDev/spring-clean-example?style=for-the-badge)](https://github.com/0xTheProDev/spring-clean-example/issues)

[![Closed Issues](https://img.shields.io/github/issues-closed-raw/0xTheProDev/spring-clean-example?style=for-the-badge)](https://github.com/0xTheProDev/spring-clean-example/issues?q=is%3Aissue+is%3Aclosed)

[![Open Pulls](https://img.shields.io/github/issues-pr-raw/0xTheProDev/spring-clean-example?style=for-the-badge)](https://github.com/0xTheProDev/spring-clean-example/pulls)

[![Closed Pulls](https://img.shields.io/github/issues-pr-closed-raw/0xTheProDev/spring-clean-example?style=for-the-badge)](https://github.com/0xTheProDev/spring-clean-example/pulls?q=is%3Apr+is%3Aclosed)

[![Contributors](https://img.shields.io/github/contributors/0xTheProDev/spring-clean-example?style=for-the-badge)](https://github.com/0xTheProDev/spring-clean-example/graphs/contributors)

[![Activity](https://img.shields.io/github/last-commit/0xTheProDev/spring-clean-example?style=for-the-badge&label=most%20recent%20activity)](https://github.com/0xTheProDev/spring-clean-example/pulse)

## Description

_Example Application Interface using Spring framework in Java_

This example showcases Repository Pattern in Hexagonal Architecture _(also known as Clean Architecture)_. Here we have two Entities - Books and Authors, whose relationships have been exploited to create CRUD endpoint in REST under OpenAPI standard.

## Installation

- Run the application using [Maven](https://maven.apache.org/):

  ```sh

  $ ./mvnw spring-boot:run

  ```

- For Windows users:

  ```powershell

  $ mvnw spring-boot:run

  ```

## Testing

- Run test suite along with Coverage reporting:

  ```sh

  $ ./mvnw jacoco:prepare-agent test install jacoco:report

  ```

  or for Windows

  ```powershell

  $ mvnw jacoco:prepare-agent test install jacoco:report

  ```

## Swagger UI

- Open Swagger UI at `localhost:8080/swagger-ui` after running the application.

## License

© MIT License