feat: OpenAPI 契约对齐与框架优化
All checks were successful
构建并部署到测试环境(无 SSH) / build-and-deploy (push) Successful in 5m45s
All checks were successful
构建并部署到测试环境(无 SSH) / build-and-deploy (push) Successful in 5m45s
主要变更: 1. OpenAPI 文档契约对齐 - 统一错误响应字段名为 msg(非 message) - 规范 envelope 响应结构(code, msg, data, timestamp) - 个人客户路由纳入文档体系(使用 Register 机制) - 新增 BuildDocHandlers() 统一管理 handler 构造 - 确保文档生成的幂等性 2. Service 层错误处理统一 - 全面替换 fmt.Errorf 为 errors.New/Wrap - 统一错误码使用规范 - Handler 层参数校验不泄露底层细节 - 新增错误码验证集成测试 3. 代码质量提升 - 删除未使用的 Task handler 和路由 - 新增代码规范检查脚本(check-service-errors.sh) - 新增注释路径一致性检查(check-comment-paths.sh) - 更新 API 文档生成指南 4. OpenSpec 归档 - 归档 openapi-contract-alignment 变更(63 tasks) - 归档 service-error-unify-core 变更 - 归档 service-error-unify-support 变更 - 归档 code-cleanup-docs-update 变更 - 归档 handler-validation-security 变更 - 同步 delta specs 到主规范文件 影响范围: - pkg/openapi: 新增 handlers.go,优化 generator.go - internal/service/*: 48 个 service 文件错误处理统一 - internal/handler/admin: 优化参数校验错误提示 - internal/routes: 个人客户路由改造,删除 task 路由 - scripts: 新增 3 个代码检查脚本 - docs: 更新 OpenAPI 文档(15750+ 行) - openspec/specs: 同步 3 个主规范文件 破坏性变更:无 向后兼容:是
This commit is contained in:
@@ -25,7 +25,7 @@ func NewAccountHandler(service *accountService.Service) *AccountHandler {
|
||||
}
|
||||
|
||||
// Create 创建账号
|
||||
// POST /api/v1/accounts
|
||||
// POST /api/admin/accounts
|
||||
func (h *AccountHandler) Create(c *fiber.Ctx) error {
|
||||
var req dto.CreateAccountRequest
|
||||
if err := c.BodyParser(&req); err != nil {
|
||||
@@ -41,7 +41,7 @@ func (h *AccountHandler) Create(c *fiber.Ctx) error {
|
||||
}
|
||||
|
||||
// Get 获取账号详情
|
||||
// GET /api/v1/accounts/:id
|
||||
// GET /api/admin/accounts/:id
|
||||
func (h *AccountHandler) Get(c *fiber.Ctx) error {
|
||||
id, err := strconv.ParseUint(c.Params("id"), 10, 64)
|
||||
if err != nil {
|
||||
@@ -57,7 +57,7 @@ func (h *AccountHandler) Get(c *fiber.Ctx) error {
|
||||
}
|
||||
|
||||
// Update 更新账号
|
||||
// PUT /api/v1/accounts/:id
|
||||
// PUT /api/admin/accounts/:id
|
||||
func (h *AccountHandler) Update(c *fiber.Ctx) error {
|
||||
id, err := strconv.ParseUint(c.Params("id"), 10, 64)
|
||||
if err != nil {
|
||||
@@ -78,7 +78,7 @@ func (h *AccountHandler) Update(c *fiber.Ctx) error {
|
||||
}
|
||||
|
||||
// Delete 删除账号
|
||||
// DELETE /api/v1/accounts/:id
|
||||
// DELETE /api/admin/accounts/:id
|
||||
func (h *AccountHandler) Delete(c *fiber.Ctx) error {
|
||||
id, err := strconv.ParseUint(c.Params("id"), 10, 64)
|
||||
if err != nil {
|
||||
@@ -93,7 +93,7 @@ func (h *AccountHandler) Delete(c *fiber.Ctx) error {
|
||||
}
|
||||
|
||||
// List 查询账号列表
|
||||
// GET /api/v1/accounts
|
||||
// GET /api/admin/accounts
|
||||
func (h *AccountHandler) List(c *fiber.Ctx) error {
|
||||
var req dto.AccountListRequest
|
||||
if err := c.QueryParser(&req); err != nil {
|
||||
@@ -109,7 +109,7 @@ func (h *AccountHandler) List(c *fiber.Ctx) error {
|
||||
}
|
||||
|
||||
// AssignRoles 为账号分配角色
|
||||
// POST /api/v1/accounts/:id/roles
|
||||
// POST /api/admin/accounts/:id/roles
|
||||
func (h *AccountHandler) AssignRoles(c *fiber.Ctx) error {
|
||||
id, err := strconv.ParseUint(c.Params("id"), 10, 64)
|
||||
if err != nil {
|
||||
@@ -130,7 +130,7 @@ func (h *AccountHandler) AssignRoles(c *fiber.Ctx) error {
|
||||
}
|
||||
|
||||
// GetRoles 获取账号的所有角色
|
||||
// GET /api/v1/accounts/:id/roles
|
||||
// GET /api/admin/accounts/:id/roles
|
||||
func (h *AccountHandler) GetRoles(c *fiber.Ctx) error {
|
||||
id, err := strconv.ParseUint(c.Params("id"), 10, 64)
|
||||
if err != nil {
|
||||
@@ -146,7 +146,7 @@ func (h *AccountHandler) GetRoles(c *fiber.Ctx) error {
|
||||
}
|
||||
|
||||
// RemoveRole 移除账号的角色
|
||||
// DELETE /api/v1/accounts/:account_id/roles/:role_id
|
||||
// DELETE /api/admin/accounts/:account_id/roles/:role_id
|
||||
func (h *AccountHandler) RemoveRole(c *fiber.Ctx) error {
|
||||
accountID, err := strconv.ParseUint(c.Params("account_id"), 10, 64)
|
||||
if err != nil {
|
||||
|
||||
Reference in New Issue
Block a user