go-zero框架的api文件通过 .api 后缀定义,核心做法是在文件中声明 type 结构体、service 服务块以及 handler 路由映射。编写时需确保结构体字段使用 json 标签指定请求参数名,并在 service 中明确指定生成的代码路径和包名。这样 goctl 工具就能根据这些规范自动生成处理 http 请求、解析 json 数据以及调用后端逻辑的完整 go 代码。

如何定义带验证规则的请求参数?
在 .api 文件中为结构体字段添加验证规则,只需在 json 标签后追加 [validations] 即可。例如使用 min=1,max=100 限制数值范围,或使用 len=6 固定字符串长度。当请求携带的数据不符合这些条件时,框架会自动拦截并返回错误信息,无需在业务代码中手动校验。

type GetUserReq struct {
Id int64 <code>`json:"id,optional" validations:"min=1"`</code>
}
service api {
@handler GetUser
get /user/<code>(:id)</code>
}
上述代码定义了获取用户信息的接口。输入参数 Id 被标记为可选,但如果提供该参数,其值必须大于等于 1。这种写法将校验逻辑下沉到配置层,使得业务处理器只关注核心逻辑。运行 goctl api go -api user.api -dir . 后,生成的代码会在中间件阶段自动执行这些检查。
如何配置服务生成与路由映射?
配置服务生成需要在 service 块中指定 go 和 package 属性,以控制输出文件的存放位置和包名。路由映射则通过在 handler 下方直接书写 HTTP 方法、路径和处理函数名来实现。这种声明式语法让路由表与业务逻辑紧密绑定,便于维护。

service order-api {
go go 1.18
package handler
target ../order-api
}
@handler CreateOrder
post /order/create
@handler ListOrders
get /order/list
这段配置告诉 goctl 使用 Go 1.18 版本,将生成的代码放入 ../order-api 目录下的 handler 包中。同时定义了两个路由:一个用于创建订单,另一个用于列出订单。路径中的 /order/create 是静态路径,而 /order/list 也是静态路径。如果路径中包含变量,如 /user/:id,框架会自动将其解析为 URL 参数并注入到对应的结构体字段中。这种机制简化了路由分发过程,开发者只需关注结构体定义和路由映射。
基于路径参数 :id 的具体问题
当 API 文件中定义的路径包含 :id 这样的动态段时,框架会自动尝试将 URL 中的对应部分解析为整数或字符串,并填充到请求结构体的同名字段中。如果类型不匹配,例如路径中提供了非数字字符但结构体字段定义为 int64,框架会直接返回 400 错误,不会进入业务处理器。


















