Leaf/rag
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
69 Commits 1 Branch 0 Tags 329 KiB
Go 98.8%
Makefile 1.2%
385739194e
Go to file
ivamp 385739194e 增加 document 结构和迁移 
改进 api
2024-07-20 23:19:25 +08:00
api/rag 增加 document 结构和迁移 2024-07-20 23:19:25 +08:00
consts 改进 2024-07-14 22:16:03 +08:00
docs 改进 swag doc 2024-07-15 01:22:40 +08:00
ent 增加 document 结构和迁移 2024-07-20 23:19:25 +08:00
internal 增加 document 结构和迁移 2024-07-20 23:19:25 +08:00
models 改进 认证和 JWKS 刷新机制 2024-07-16 01:48:05 +08:00
.env.example update example env 2024-06-16 16:25:51 +08:00
.gitignore ignore 2024-06-13 14:27:13 +08:00
buf.gen.yaml update 2024-07-15 21:08:48 +08:00
buf.lock 增加 document 结构和迁移 2024-07-20 23:19:25 +08:00
buf.yaml update 2024-07-15 21:08:48 +08:00
go.mod update 2024-07-15 21:08:48 +08:00
go.sum update 2024-07-15 21:08:48 +08:00
main_test.go feat: http di 2024-06-16 00:45:32 +08:00
main.go setup project 2024-07-14 23:58:23 +08:00
Makefile 增加 document 结构和迁移 2024-07-20 23:19:25 +08:00
README.md update http and grpc handler 2024-06-16 19:24:02 +08:00

README.md

使用步骤

  1. 运行 go run . setup 初始化项目
  2. 按需到到 internal/app, internal/cmd/migrate.go 中初始化 ent 或其他组件

规范

初始化规范

  1. 所有需要初始化的组件，都需要单独放在 init.go 中，然后显示初始化。
  2. 禁止在 main.go 中初始化任何组件。
  3. 部分组件对初始化顺序有要求，禁止使用 init() 方法来初始化。

组件存放

  1. 所有组件都放在 internal/app 目录下，每个组件一个目录。
  2. 组件所需要的文件可以放在 internal 下，比如 gin 需要路由定义。

业务逻辑

  1. 所有业务逻辑都放在 internal/services 目录下，每个业务一个目录，比如 user 部分就应该单独一个目录。
  2. handlers/controller 每个业务一个目录。
  3. controller 中不应该有业务逻辑，handlers/controller 只负责接收请求，然后调用 services 中的业务逻辑。
  4. handlers/grpc 为 gRPC 的 handler，里面不处理业务逻辑，业务逻辑应在 services 中处理。