go-clean-architecture

项目介绍：Go Clean Architecture

Go Clean Architecture 是一个用户友好的解决方案，致力于处理一系列银行相关的任务。这个项目的主要功能包括创建账户、列出账户信息、查询特定账户的余额、执行账户间的转账以及编制转账记录等功能。它为开发者提供了一种简洁、干净的架构设计，便于理解和扩展。

架构设计

关于 Go Clean Architecture 的设计，它代表了一种“干净架构”的实现尝试。所谓“干净架构”是指通过模块化设计，使得业务逻辑不依赖于任何外部框架。这样使得系统更易于测试和维护。如果读者对这种架构尚不熟悉，可以参考相关资料来加深理解。

账户创建用例示例

在账户创建功能中，Go Clean Architecture 明确展示了如何通过清晰的模块分工，使得账户创建流程既高效又易于管理。

必要条件和依赖

为了运行该项目，开发者需要具备以下工具：

• Docker
• Docker-compose

快速上手

为了帮助开发者快速开始项目，Go Clean Architecture 提供了一系列便捷的命令：

• 初始化环境变量

  make init
  

• 在开发模式下启动API

  make up
  

• 在容器中运行测试

  make test
  

• 本地运行测试（需安装 Golang）

  make test-local
  

• 运行覆盖率报告

  make test-report
  

  make test-report-func
  

• 查看日志

  make logs
  

API 请求

该项目提供了一系列 RESTful API 接口，供客户端访问和操作银行账户信息：

使用 curl 测试 API

以下是一些常见的 API 请求示例：

• 创建新账户

  请求:

  curl -i --request POST 'http://localhost:3001/v1/accounts' \
  --header 'Content-Type: application/json' \
  --data-raw '{
      "name": "Test",
      "cpf": "070.910.584-24",
      "balance": 100
  }'
  

  响应:

  {
      "id":"5cf59c6c-0047-4b13-a118-65878313e329",
      "name":"Test",
      "cpf":"070.910.584-24",
      "balance":1,
      "created_at":"2020-11-02T14:50:46Z"
  }
  

• 列出账户

  请求:

  curl -i --request GET 'http://localhost:3001/v1/accounts'
  

  响应:

  [
      {
          "id": "5cf59c6c-0047-4b13-a118-65878313e329",
          "name": "Test",
          "cpf": "070.910.584-24",
          "balance": 1,
          "created_at": "2020-11-02T14:50:46Z"
      }
  ]
  

• 查询账户余额

  请求:

  curl -i --request GET 'http://localhost:3001/v1/accounts/{{account_id}}/balance'
  

  响应:

  {
      "balance": 1
  }
  

• 创建新转账

  请求:

  curl -i --request POST 'http://localhost:3001/v1/transfers' \
  --header 'Content-Type: application/json' \
  --data-raw '{
      "account_origin_id": "{{account_id}}",
      "account_destination_id": "{{account_id}}",
      "amount": 100
  }'
  

  响应:

  {
      "id": "b51cd6c7-a55c-491e-9140-91903fe66fa9",
      "account_origin_id": "{{account_id}}",
      "account_destination_id": "{{account_id}}",
      "amount": 1,
      "created_at": "2020-11-02T14:57:35Z"
  }
  

• 列出转账记录

  请求:

  curl -i --request GET 'http://localhost:3001/v1/transfers'
  

  响应:

  [
      {
          "id": "b51cd6c7-a55c-491e-9140-91903fe66fa9",
          "account_origin_id": "{{account_id}}",
          "account_destination_id": "{{account_id}}",
          "amount": 1,
          "created_at": "2020-11-02T14:57:35Z"
      }
  ]
  

Git 工作流程

项目使用 Gitflow 工作流程，以有序地管理开发过程。

开发状态

目前项目处于开发阶段，欢迎对其进行改进和贡献。

作者信息

该项目由 Gabriel Sabadini Facina 设计与开发，他在 GitHub 上的用户名是 GSabadini。

许可证

本项目采用 MIT 许可证，版权归 GSabadini 所有，版权所有。