Skip to content

快速开始

1. 选择模块

浏览 模块 部分或 registry/ 目录找到你需要的模块。

2. 复制模块

bash
# 示例:复制 auth 模块
cp -r registry/auth/src/go/* yourproject/internal/auth/

3. 适配模块

每个模块的 README.md 包含适配清单:

  1. 数据库层 — 实现 store 接口
  2. 配置 — 设置环境变量
  3. 路由 — 根据需要调整前缀

4. 运行测试

bash
# 运行测试
cd yourproject/internal/auth
go test -v ./...

可用模块

模块描述
AuthJWT 认证 + bcrypt
CRUD通用 CRUD + 分页
MiddlewareRecovery、CORS、日志、超时
RBAC基于角色的访问控制
Rate Limit固定/滑动窗口、令牌桶
Validation链式请求验证
File Upload安全文件上传
Health存活/就绪探针
CacheTTL + LRU 内存缓存
Pagination偏移/游标分页
MailSMTP 邮件 + 模板

项目结构

每个模块遵循以下结构:

registry/<module>/
├── src/go/
│   ├── go.mod              # module <name>, go 1.22
│   ├── config.go           # Options struct, Defaults(), FromEnv()
│   ├── handler.go          # HTTP handlers
│   ├── <core>.go           # 核心逻辑
│   ├── <core>_test.go      # 功能测试
│   └── pentest_test.go     # 渗透测试用例
├── README.md               # 人类可读的适配指南
└── __llms__.md             # AI可读的摘要 (~150 tokens)

下一步

Released under the MIT License.