Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/gsabadini/golang-clean-architecture

Implementation of Clean Architecture using Golang :rocket:
https://github.com/gsabadini/golang-clean-architecture

architecture banking clean-architecture clean-code cleanarchitecture docker go go-clean-architecture golang golang-cleanarchitecture golang-clear-arch hexagonal-architecture mongodb onion-architecture payments rabbitmq

Last synced: 5 days ago
JSON representation

Implementation of Clean Architecture using Golang :rocket:

Host: GitHub
URL: https://github.com/gsabadini/golang-clean-architecture
Owner: GSabadini
License: mit
Created: 2020-09-15T05:05:19.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2023-11-13T19:12:16.000Z (about 1 year ago)
Last Synced: 2024-06-20T12:02:59.967Z (5 months ago)
Topics: architecture, banking, clean-architecture, clean-code, cleanarchitecture, docker, go, go-clean-architecture, golang, golang-cleanarchitecture, golang-clear-arch, hexagonal-architecture, mongodb, onion-architecture, payments, rabbitmq
Language: Go
Homepage:
Size: 388 KB
Stars: 23
Watchers: 4
Forks: 2
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

Golang Clean Architecture :rocket:

## Architecture
- The whole code is based on my view about "clean architecture" and how to build maintainable projects. If you don’t know clean architecture yet, [here's](https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html) a reference.
![Clean Architecture](clean.png)

## Objective

We have 2 types of users, common and merchant, both have wallet with money and make transfers between themselves.

Requirements:

- For both types of user, we need the Full Name, CPF, e-mail and Password. CPF/CNPJ and e-mails must be unique in the system. Therefore, your system should allow only one registration with the same CPF or e-mail address.

- Common users can send money (make transfers) to merchants and between common users.

- Merchant users only receive transfers, do not send money to anyone.

- Before finalizing the transfer, an external authorization service must be consulted, use this mock to simulate (https://run.mocky.io/v3/8fafdd68-a090-496f-8c9a-3442cf30dae6).

- The transfer operation must be a transaction (that is, reversed in any case of inconsistency) and the money must be returned to the sending user's wallet.

- Upon receiving payment, the common user or merchant needs to receive the notification sent by a third party service and eventually this service may become unavailable/unstable. Use this simulation to simulate sending (https://run.mocky.io/v3/b19f7b9f-9cbf-4fc6-ad22-dc30601aec04).

- This service must be RESTFul.

## Requirements/dependencies
- Docker
- Docker-compose

## Getting Started

- Starting API in port `:3001`

```sh
make start
```

- Run the tests using a container

```sh
make test
```

- Run the tests using a local machine

```sh
make test-local
```

- Run coverage

```sh
make coverage
```

- View the application logs

```sh
make logs
```

- Destroy application

```sh
make down
```

## API Endpoint

| Endpoint | HTTP Method | Description |
| :----------------: | :-------------------: | :-------------------: |
| `/users` | `POST` | `Create user` |
| `/users/{:userId}` | `GET` | `Find user by ID` |
| `/transfers` | `POST` | `Create transaction` |
| `/health` | `GET` | `Health check` |

## Test endpoints API using curl

- #### Creating new user

`Request`
```bash
curl -i --request POST 'localhost:3001/users' \
--header 'Content-Type: application/json' \
--data-raw '{
"fullname": "Gabriel Gabriel",
"email": "[email protected]",
"password": "passw123",
"document": {
"type": "CPF",
"value": "070.910.549-64"
},
"wallet": {
"currency": "BRL",
"amount": 100
},
"type": "common"
}'
```

`Response`
```bash
HTTP/1.1 201 Created
Content-Type: application/json
X-Correlation-Id: c6b9d518-1d84-4100-806b-46be21312dc7
Date: Mon, 09 Nov 2020 22:09:27 GMT
Content-Length: 302
```
```json
{
"id": "0db298eb-c8e7-4829-84b7-c1036b4f0791",
"full_name": "Common user",
"email": "[email protected]",
"password": "passw",
"document": {
"type": "CPF",
"value": "07091054954"
},
"wallet": {
"currency": "BRL",
"amount": 100
},
"roles": {
"can_transfer": true
},
"type": "COMMON",
"created_at": "0001-01-01T00:00:00Z"
}
```

- #### Find user by ID

`Request`
```bash
curl -i --request GET 'http://localhost:3001/users/{:userId}'
```

`Response`
```bash
HTTP/1.1 200 OK
Content-Type: application/json
X-Correlation-Id: ec8b22a2-17a9-41a9-b6e8-192b653655d6
Date: Mon, 09 Nov 2020 22:10:39 GMT
Content-Length: 279
```
```json
{
"id": "0db298eb-c8e7-4829-84b7-c1036b4f0791",
"fullname": "Common user",
"email": "[email protected]",
"document": {
"type": "CPF",
"value": "07091054954"
},
"wallet": {
"currency": "BRL",
"amount": 100
},
"roles": {
"can_transfer": true
},
"type": "COMMON",
"created_at": "0001-01-01T00:00:00Z"
}
```

- #### Create new transaction

`Request`
```bash
curl -i --request POST 'localhost:3001/transfers' \
--header 'Content-Type: application/json' \
--data-raw '{
"payer_id": {:userId},
"payee_id": {:userId},
"value": 100
}'
```

`Response`
```bash
HTTP/1.1 201 Created
Content-Type: application/json
X-Correlation-Id: 9b2c2433-6316-4321-8c9a-56366cdd3d1b
Date: Mon, 09 Nov 2020 22:11:51 GMT
Content-Length: 186
```
```json
{
"id": "0db298eb-c8e7-4829-84b7-c1036b4f0791",
"payer_id": "0db298eb-c8e7-4829-84b7-c1036b4f0791",
"payee_id": "0db298eb-c8e7-4829-84b7-c1036b4f0792",
"value": 100,
"created_at": "0001-01-01T00:00:00Z"
}
```