Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sergiocostan26/price-retriever-hexagonal
Demo service applying the Hexagonal architecture.
https://github.com/sergiocostan26/price-retriever-hexagonal
hexagonal hexagonal-architecture kotlin ports-and-adapters
Last synced: 6 days ago
JSON representation
Demo service applying the Hexagonal architecture.
- Host: GitHub
- URL: https://github.com/sergiocostan26/price-retriever-hexagonal
- Owner: sergiocostaN26
- Created: 2024-01-30T21:40:52.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-06-08T13:08:24.000Z (5 months ago)
- Last Synced: 2024-08-03T12:26:31.750Z (3 months ago)
- Topics: hexagonal, hexagonal-architecture, kotlin, ports-and-adapters
- Language: Kotlin
- Homepage:
- Size: 124 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# price-retriever-hexagonal
The purpose of this project is to build a demo service
using **domain-driven design** and **hexagonal architecture**.
The topic turns around prices linked to timeframes and the query of them.
## Prerequisites
- Java 17
- Docker
## Installation
1. Clone the repository
```sh
git clone [email protected]:sergiocmgit/price-retriever-hexagonal.git
```
2. Build the image
```sh
./gradlew build
```
3. Build the docker image
```sh
docker build -t price-retriever-hexagonal .
```
4. Run the application
```sh
docker run -p 8080:8080 price-retriever-hexagonal
```
5. Call the endpoint
```sh
curl -X GET "http://localhost:8080/api/prices?productId=35455&brandId=1&appliedAt=2020-06-14T10%3A00%3A00Z"
```
## Documentation
Check the documentation when the application is running by accessing the following:
- Swagger documentation: [Swagger UI](http://localhost:8080/swagger-ui/index.html#/)
- OpenAPI documentation in json format: [OpenAPI in JSON](http://localhost:8080/v3/api-docs)
- OpenAPI documentation in yaml format: [OpenAPI in YAML](http://localhost:8080/v3/api-docs.yaml)