o-w-o/dot

convention($module=core): 项目约定 核心

Opened this issue · 0 comments

o-w-o commented

数据格式 definition

  • 服务泛型：ServiceResult
  • 接口泛型：ApiResult
  • 异常处理 Exception
    • 全局异常处理：ApiExceptionsControllerAdvice
    • 接口异常：ApiException
    • 服务异常：ServiceException
    • 系统异常：SystemException

安全配置 security

  • 权限配置：访问控制形式
  • 认证 / 授权
    • 认证：JWT 生成、注册、校验、刷新、注销
    • 授权：解析、注入

数据库 database

  • postgrel
    • 资源：
      • 用户
      • 权限
  • redis
    • 认证
    • IP 访问限制
    • 接口访问限制
  • flyway
    • 数据库维护

缓存 cache

  • redis

测试 test

  • 单元测试
  • 测试覆盖率

持续集成 / 部署 ci/cd

  • Aliyun Docker Registry
  • Github App Integration
  • Jenkins

代码自动生成

  • 接口 OpenApi