gin
installsforks
How to install gin?
youlaitech/youlai-skills/gin
$npx -y skills add youlaitech/youlai-skills --skill ginGin backend development standards. Use this skill when developing Go/Gin projects, implementing REST APIs, using GORM, JWT authentication, or permission control.
SKILL.md
| 1 | # Gin 后端开发规范 |
| 2 | |
| 3 | ## 触发条件 |
| 4 | |
| 5 | - Develop Gin projects |
| 6 | - Implement REST APIs |
| 7 | - Use GORM for data access |
| 8 | - Implement JWT authentication |
| 9 | - Implement permission control |
| 10 | |
| 11 | --- |
| 12 | |
| 13 | ## Part 1: 技术栈 |
| 14 | |
| 15 | | 层 | 选型 | 说明 | |
| 16 | |----|------|------| |
| 17 | | 运行环境 | **Go 1.22+** | 标准库健壮、并发原生 | |
| 18 | | Web 框架 | **Gin** | 高性能 HTTP 路由器 | |
| 19 | | ORM | **GORM 2.0** | 链式查询、自动迁移 | |
| 20 | | 数据库 | **MySQL 8.x** | InnoDB 引擎 | |
| 21 | | 缓存 | **Redis 7.x** (go-redis) | 分布式缓存 | |
| 22 | | 认证 | **golang-jwt** | JWT 签发/验签 | |
| 23 | | 日志 | **zap / slog** | 结构化日志 | |
| 24 | | API 文档 | **swaggo/swag** (swag init) | OpenAPI 自动生成 | |
| 25 | |
| 26 | --- |
| 27 | |
| 28 | ## Part 2: 目录结构 |
| 29 | |
| 30 | > 基础目录以 [Standard Go Project Layout](https://github.com/golang-standards/project-layout) 为准；`internal/` 在此基础上按业务模块（`auth`、`system` 等）划分，模块内含 handler/model/service/router。 |
| 31 | |
| 32 | ``` |
| 33 | ├── main.go # 程序入口 |
| 34 | ├── internal/ # 私有代码（Go 编译器强制不可被外部导入） |
| 35 | │ ├── auth/ # 认证模块 |
| 36 | │ │ ├── handler/{auth_handler, wxma_handler}.go |
| 37 | │ │ ├── model/{request, captcha, wxma_model}.go |
| 38 | │ │ ├── service/{auth_service, wxma_service}.go |
| 39 | │ │ └── router.go |
| 40 | │ ├── system/ # 系统管理（按实体分子模块） |
| 41 | │ │ ├── user/ # handler/user_handler.go + model/{entity,form,query,vo}.go + repository + service |
| 42 | │ │ ├── role/ # 同上 + role_perms_repo, cache_service |
| 43 | │ │ ├── menu/ dept/ dict/ config/ notice/ log/ |
| 44 | │ │ └── router.go |
| 45 | │ ├── codegen/ # 代码生成器 |
| 46 | │ ├── file/ # 文件模块 |
| 47 | │ ├── message/ # 消息模块（SSE 推送） |
| 48 | │ ├── common/ # 公共组件 |
| 49 | │ │ ├── auth/ # JWT / Redis Token 管理 + Middleware |
| 50 | │ │ ├── config/ # 全局配置加载 |
| 51 | │ │ ├── context/ # 上下文（用户信息） |
| 52 | │ │ ├── database/ # GORM + 分页 |
| 53 | │ │ ├── permission/ # 权限服务 + 数据权限 |
| 54 | │ │ ├── redis/ # Redis 客户端 |
| 55 | │ │ ├── storage/ # 文件存储（本地/阿里云） |
| 56 | │ │ ├── validator/ # 自定义校验器 |
| 57 | │ │ └── response.go # 统一响应 |
| 58 | │ ├── middleware/ # 全局中间件（error_handler, permission, rate_limiter, requestid） |
| 59 | │ └── router/register.go # 路由注册入口 |
| 60 | ├── pkg/ # 公共库（可被外部项目导入） |
| 61 | │ ├── constant/{business, error_code}.go |
| 62 | │ ├── enums/{action_type, log_module}.go |
| 63 | │ ├── errs/errs.go # 统一错误定义 |
| 64 | │ ├── model/{entity, option, pagination}.go |
| 65 | │ └── types/{bigint, time}.go |
| 66 | ├── configs/ # 配置文件（dev/prod/test.yaml） |
| 67 | ├── docs/ # Swagger 文档（swag init -o docs 生成） |
| 68 | ├── docker/docker-compose.yml |
| 69 | ├── go.mod / go.sum |
| 70 | ``` |
| 71 | |
| 72 | **设计原则**： |
| 73 | - `internal/` 不可被外部项目导入（Go 编译器强约束） |
| 74 | - `pkg/` 可被外部项目复用 |
| 75 | - 每业务模块按 Handler → Service → Repository 四层架构，model 放 DTO/Entity/VO |
| 76 | - `internal/common/` 是内部公共基础设施，不依赖业务模块 |
| 77 | |
| 78 | | 层 | 目录 | 职责 | |
| 79 | |----|------|------| |
| 80 | | Handler | `handler/` | HTTP 请求处理 | |
| 81 | | Model | `model/` | 实体、DTO、VO、查询 | |
| 82 | | Repository | `repository/` | 数据访问（GORM 查询） | |
| 83 | | Service | `service/` | 业务逻辑 | |
| 84 | |
| 85 | --- |
| 86 | |
| 87 | ## Part 3: 命名规范 |
| 88 | |
| 89 | ### 3.1 文件命名 |
| 90 | |
| 91 | | 类型 | 规范 | 示例 | |
| 92 | |------|------|------| |
| 93 | | Handler | `{name}_handler.go` | `user_handler.go` | |
| 94 | | Service | `{name}_service.go` | `user_service.go` | |
| 95 | | Repository | `{name}_repo.go` | `user_repo.go` | |
| 96 | | Entity | `{name}.go` | `user.go` | |
| 97 | | DTO/VO | `{name}.go` 在 model/ 下 | `user_form.go`, `user_vo.go` | |
| 98 | |
| 99 | ### 3.2 命名原则 |
| 100 | |
| 101 | - **简洁不冗余**：包名已提供上下文，类型名不要重复包名 |
| 102 | - 导出（大写）`GetByID`，非导出（小写）`parseToken` |
| 103 | - `context.Context` 始终作为函数第一个参数 |
| 104 | |
| 105 | ```go |
| 106 | // ❌ 冗余：包名 user 已表明上下文 |
| 107 | package user |
| 108 | type UserService struct{} // → 调用时变成 user.UserService |
| 109 | |
| 110 | // ✅ 简洁 |
| 111 | package user |
| 112 | type Service struct{} // → 调用时 user.Service，包名已提供语义 |
| 113 | ``` |
| 114 | |
| 115 | ### 3.3 方法命名 |
| 116 | |
| 117 | | 动作 | 前缀 | 示例 | |
| 118 | |------|------|------| |
| 119 | | 查询单个 | Get | `GetByID(ctx, id)` | |
| 120 | | 查询列表 | List | `List(ctx, query)` | |
| 121 | | 分页查询 | Page | `Page(ctx, query)` | |
| 122 | | 新增 | Create | `Create(ctx, form)` | |
| 123 | | 更新 | Update | `Update(ctx, form)` | |
| 124 | | 删除 | Delete | `Delete(ctx, id)` | |
| 125 | |
| 126 | ### 3.4 变量命名 |
| 127 | |
| 128 | | 类型 | 规范 | 示例 | |
| 129 | |------|------|------| |
| 130 | | 变量 | camelCase | `userList` | |
| 131 | | 常量 | PascalCase | `MaxSize` | |
| 132 | | 私有变量 | 小写开头 | `internalState` | |
| 133 | | 布尔值 | Is/Has/Can 前缀 | `isDeleted`, `hasPermission` | |
| 134 | |
| 135 | ### 3.5 import 排序 |
| 136 | |
| 137 | ```go |
| 138 | import ( |
| 139 | // 1. 标准库 |
| 140 | "context" |
| 141 | "time" |
| 142 | |
| 143 | // 2. 第三方库 |
| 144 | "github.com/gin-gonic/gin" |
| 145 | "gorm.io/gorm" |
| 146 | |
| 147 | // 3. 本项目内部 |
| 148 | "youlai/gin/internal/common/response" |
| 149 | "youlai/gin/pkg/errs" |
| 150 | ) |
| 151 | ``` |
| 152 | |
| 153 | --- |
| 154 | |
| 155 | ## Part 4: RESTful API 规范 |
| 156 | |
| 157 | ### 4.1 标准 CRUD 路径 |
| 158 | |
| 159 | | 操作 | 方法 | 路径 | |
| 160 | |------|------|------| |
| 161 | | 分页列表 | `GET` | `/api/v1/users/page` | |
| 162 | | 详情 | `GET` | `/api/v1/users/:id` | |
| 163 | | 新增 | `POST` | `/api/v1/users` | |
| 164 | | 更新 | `PUT` | `/api/v1/users` | |
| 165 | | 删除 | `DELETE` | `/api/v1/users/:id` | |
| 166 | | 批量删除 | `DELETE` | `/api/v1/users/batch` | |
| 167 | | 下拉选项 | `GET` | `/api/v1/users/options` | |
| 168 | |
| 169 | ### 4.2 Handler 模板 |
| 170 | |
| 171 | ```go |
| 172 | // Page 用户分页列表 |
| 173 | // @Summary 用户分页列表 |
| 174 | // @Tags 用户管理 |
| 175 | // @Accept json |
| 176 | // @Produce json |
| 177 | // @Param query query model.User |
People who liked this also viewed
6 picksType
- find-skillsHelps users discover and install agent skills when they ask questions like "how do I do X", "find a skill for X", "is there a skill that can...", or express interest in extending capabilities. This skSkillsJul 2026
- grill-meA relentless interview to sharpen a plan or design.SkillsJul 2026
- vercel-react-best-practicesVercel's official collection of agent skillsSkillsJul 2026
- improve-codebase-architectureScan a codebase for deepening opportunities, present them as a visual HTML report, then grill through whichever one you pick.SkillsJul 2026
- setup-matt-pocock-skillsConfigure this repo for the engineering skills — set up its issue tracker, triage label vocabulary, and domain doc layout. Run once before first use of the other engineering skills.SkillsJul 2026
- triageMove issues and external PRs through a state machine of triage roles — categorise, verify, grill if needed, and write agent-ready briefs.SkillsJul 2026
