Go最全go-zero学习 第二章 进阶之API_go-zero syntax是用来干什么的，讲的真详细

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化的资料的朋友，可以添加戳这里获取

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

• 重要提示
• 相关命令
• 2 API 语法
• 3 API服务代码实战
• • 3.1 请求参数、文件上传/预览、分组示例
    • 3.2 中间件、统一返回信息 代码示例
    • 3.3 修改统一返回信息的代码生成模板

重要提示

1. 因官网重新改版，本文是基于官网最新版本的文档并整合旧文档重新进行全面总结、归纳。
2. 本文主要对官网 指南 进行提炼总结，未涉及部分将在后续章节陆续补充完善。
3. API部分主要是对外提供服务，go-zero可以通过编写一个 api 文件，生成一个完整的api服务。

相关命令

1. api生成api服务命令

go-zero-api\api> goctl api go -api ./doc/ucenter.api -dir ./code

2 API 语法

参考1：语句

api文件中包含以下语句，按从上到下的顺序：

1. syntax 语句
2. info 语句
3. import 语句
4. 结构体语句（HTTP 服务的请求/响应体语句）
5. @server 语句
6. @doc 语句
7. @handler 语句
8. HTTP 路由语句
9. HTTP 服务声明语句
10. 注释语句

---

完整的 api 语法示例：

syntax = "v1"

info (
    title:   "api 文件完整示例写法"
    desc:    "演示如何编写 api 文件"
    author:  "keson.an"
    date:    "2022 年 12 月 26 日"
    version: "v1"
)

type UpdateReq {
    Arg1 string `json:"arg1"`
}

type ListItem {
    Value1 string `json:"value1"`
}

type LoginReq {
    Username string `json:"username"`
    Password string `json:"password"`
}

type LoginResp {
    Name string `json:"name"`
}

type FormExampleReq {
    Name string `form:"name"`
}

type PathExampleReq {
    // path 标签修饰的 id 必须与请求路由中的片段对应，如
    // id 在 service 语法块的请求路径上一定会有 :id 对应，见下文。
    ID string `path:"id"`
}

type PathExampleResp {
    Name string `json:"name"`
}

@server (
    jwt:        Auth // 对当前 Foo 语法块下的所有路由，开启 jwt 认证，不需要则请删除此行
    prefix:     /v1 // 对当前 Foo 语法块下的所有路由，新增 /v1 路由前缀，不需要则请删除此行
    group:      g1 // 对当前 Foo 语法块下的所有路由，路由归并到 g1 目录下，不需要则请删除此行
    timeout:    3s // 对当前 Foo 语法块下的所有路由进行超时配置，不需要则请删除此行
    middleware: AuthInterceptor // 对当前 Foo 语法块下的所有路由添加中间件，不需要则请删除此行
    maxBytes:   1024 // 对当前 Foo 语法块下的所有路由添加请求体大小控制，单位为 byte,goctl 版本 >= 1.5.0 才支持
)
service Foo {
    // 定义没有请求体和响应体的接口，如 ping
    @handler ping
    get /ping

    // 定义只有请求体的接口，如更新信息
    @handler update
    post /update (UpdateReq)

    // 定义只有响应体的结构，如获取全部信息列表
    @handler list
    get /list returns ([]ListItem)

    // 定义有结构体和响应体的接口，如登录
    @handler login
    post /login (LoginReq) returns (LoginResp)

    // 定义表单请求
    @handler formExample
    post /form/example (FormExampleReq)

    // 定义 path 参数
    @handler pathExample
    get /path/example/:id (PathExampleReq) returns (PathExampleResp)
}

其他示例：https://go-zero.dev/docs/tasks/dsl/api#快速入门

---

1 syntax 语句
syntax 语句用于标记 api 语言的版本，不同的版本可能语法结构有所不同，随着版本的提升会做不断的优化，当前版本为 v1。

示例：

syntax = "v1"

---

2 info 语句
info 语句是 api 语言的 meta 信息，其仅用于对当前 api 文件进行描述，暂不参与代码生成，其和注释还是有一些区别，注释一般是依附某个 syntax 语句存在，而 info 语句是用于描述整个 api 信息的，当然，不排除在将来会参与到代码生成里面来。

示例：

info(
	title : "XXX系统"
	author: "哈哈哈"
	email: "123456@qq.com"
	version: "1.0.0.0"
)

---

3 import 语句
import 语句是在当前 api 中引入其他 api 文件的语法块，其支持相对/绝对路径，不支持 package 的设计，如 time.Time。

示例：

// 单行 import
import "foo"
import "/path/to/file"

// import 组
import ()
import (
    "bar"
    "relative/to/file"
)

---

4 结构体语句（HTTP 服务的请求/响应体语句）
api 中的数据类型基本沿用了 Golang 的数据类型，用于对 rest 服务的请求/响应体结构的描述。

示例1：

// 别名类型 [1]
type Int int
type Integer = int

// 空结构体
type Foo {}

// 单个结构体
type Bar {
    Foo int               `json:"foo"`
    Bar bool              `json:"bar"`
    Baz []string          `json:"baz"`
    Qux map[string]string `json:"qux"`
}

type Baz {
    Bar    `json:"baz"`
    // 结构体内嵌 [2]
    Qux {
        Foo string `json:"foo"`
        Bar bool   `json:"bar"`
    } `json:"baz"`
}

// 空结构体组
type ()

// 结构体组
type (
    Int int
    Integer = int
    Bar {
        Foo int               `json:"foo"`
        Bar bool              `json:"bar"`
        Baz []string          `json:"baz"`
        Qux map[string]string `json:"qux"`
    }
)

示例2（实际使用）：

type (
	/\* 1 公用类 \*/
	BaseModel {
		Id   int64  `json:"id"`   // id
		Name string `json:"name,optional"` // 名称
		Data string `json:"data,optional"` // 数据:string
	}

	/\* 2 公共返回 \*/
	BaseModelResp {
		Code    string       `json:"code"`    // 状态码
		Message string       `json:"message"` // 提示信息
		Data    []\*BaseModel `json:"data,optional"`
	}
	
	/\* 3 分类标签接口的返回数据 \*/
	GetClassLabelResp {
		Code           string       `json:"code"`           // 状态码
		Message        string       `json:"message"`        // 提示信息
		ClassLabelList []\*BaseModel `json:"classLabelList"` // 分类标签集合:id-名称
	}
)

注意：

1. 虽然语法上支持别名，但是在语义分析时会对别名进行拦截，这或在将来进行放开。
2. 虽然语法上支持结构体内嵌，但是在语义分析时会对别名进行拦截，这或在将来进行放开。

除此之外：

1. 目前 api 语法中虽然支持了数组的语法，但是在语义分析时会对数组进行拦截，目前建议用切片替代，这或在将来放开。
2. 不支持 package 设计，如 time.Time。

---

5 @server 语句
@server 语句是对一个服务语句的 meta 信息描述，其对应特性包含但不限于：

• jwt 开关
• 中间件
• 路由分组
• 路由前缀

示例1：

// 空内容
@server()

// 有内容
@server (
    // jwt 声明
    // 如果 key 固定为 “jwt:”，则代表开启 jwt 鉴权声明
    // value 则为配置文件的结构体名称
    jwt: Auth

    // 路由前缀
    // 如果 key 固定为 “prefix:”
    // 则代表路由前缀声明，value 则为具体的路由前缀值，字符串中没让必须以 / 开头
    prefix: /v1

    // 路由分组
    // 如果 key 固定为 “group:”，则代表路由分组声明
    // value 则为具体分组名称，在 goctl生成代码后会根据此值进行文件夹分组
    group: Foo

    // 中间件
    // 如果 key 固定为 middleware:”，则代表中间件声明
    // value 则为具体中间件函数名称，在 goctl生成代码后会根据此值进生成对应的中间件函数
    middleware: AuthInterceptor

    // 超时控制
    // 如果 key 固定为 timeout:”，则代表超时配置
    // value 则为具体中duration，在 goctl生成代码后会根据此值进生成对应的超时配置
    timeout: 3s

    // 其他 key-value，除上述几个内置 key 外，其他 key-value
    // 也可以在作为 annotation 信息传递给 goctl 及其插件，但就
    // 目前来看，goctl 并未使用。
    foo: bar
)

示例2（实际使用）：

@server(
	jwt: Auth
	middleware: CheckUrl
	group: app/appSystem
	prefix: /app/appSystem
)

---

6 @doc 语句
@doc 语句是对单个路由的 meta 信息描述，一般为 key-value 值，可以传递给 goctl 及其插件来进行扩展生成。

示例1：

// 单行 @doc
@doc "foo"

// 空 @doc 组
@doc ()

// 有内容的 @doc 组
@doc (
    foo: "bar"
    bar: "baz"
)

示例2（实际使用）：

    @doc(
        summary: "XXX列表"
    )

---

7 @handler 语句
@handler 语句是对单个路由的 handler 信息控制，主要用于生成 golang http.HandleFunc 的实现转换方法。

示例：

@handler foo

@handler GetClassLabelHandler

注意：不论定义的handler是否有handler后缀，goctl根据api实际生成的代码文件均会以xxxhandler为后缀，所以在api中定义handler时加不加handler后缀没有意义。

---

8 HTTP 路由语句
路由语句是对此 HTTP 请求的具体描述，包括请求方法，请求路径，请求体，响应体信息。

示例：

// 没有请求体和响应体的写法
get /ping

// 只有请求体的写法
get /foo (foo)

// 只有响应体的写法
post /foo returns (foo)

// 有请求体和响应体的写法
post /foo (foo) returns (bar)

---

9 HTTP 服务声明语句
示例：

// 带 @server 的写法
@server (
    prefix: /v1
    group: Login
)
service user {
    @doc "登录"
    @handler login
    post /user/login (LoginReq) returns (LoginResp)

    @handler getUserInfo
    get /user/info/:id (GetUserInfoReq) returns (GetUserInfoResp)
}
@server (
    prefix: /v1
    middleware: AuthInterceptor
)
service user {
    @doc "登录"
    @handler login
    post /user/login (LoginReq) returns (LoginResp)

    @handler getUserInfo
    get /user/info/:id (GetUserInfoReq) returns (GetUserInfoResp)
}


// 不带 @server 的写法
service user {
    @doc "登录"
    @handler login
    post /user/login (LoginReq) returns (LoginResp)

    @handler getUserInfo
    get /user/info/:id (GetUserInfoReq) returns (GetUserInfoResp)
}

---

10 注释语句
在 api 领域特性语言中有 2 种格式：

• 单行注释以 // 开始，行尾结束。
• 多行注释（文档注释）以 /* 开始，以第一个 */ 结束。

3 API服务代码实战

参考1：请求参数

前面讲解了api文件的语法，这里在使用时具体讲解一些细节，主要有以下内容：

1. path参数
2. form参数
3. json参数
4. header参数
5. 参数修饰符
6. 文件上传/下载
7. 请求体大小限制
8. api分组
9. 中间件
10. 统一返回信息
11. 鉴权【需要结合rpc服务，下一节再讲解】

1、2、3、4、5、6、7都是针对请求参数，1、2、3、4可以划归为一组，在绑定参数时，只能选择1、2、3、4其中一个。

请求参数：

标签类型	描述	提供方	使用范围	示例
path	路由path，如/foo/:id	go-zero	request	path:"id"
form	标志请求体是一个form（POST方法时）或者一个query(GET方法时/search?name=keyword)	go-zero	request	form:"name"
json	json序列化tag	golang	request、response	json:"fooo"
header	HTTP header，如 Name: value	go-zero	request	header:"name"

---

参数修饰符：

标签类型	描述	提供方	使用范围	示例
optional	定义当前字段为可选参数	go-zero	request	json:"name,optional"
options	定义当前字段的枚举值，多个以,隔开	go-zero	request	json:"gender,options=male,emale"
default	定义当前字段默认值	go-zero	request	json:"gender,default=male"
range	定义当前字段数值范围	go-zero	request	json:"age,range=[0:120]"

---

3.1 请求参数、文件上传/预览、分组示例

代码：请求参数、文件上传/预览、分组示例 代码示例
1 api文件：

syntax = "v1"

info(
	title : "go-zero-api"
	desc: "ucenter"
	author: "ximuqi"
	email: "xxx"
	version: "0.0.1"
)

type (
	/* 1 公用类（json） */
	BaseModelJson {
		Id   int64  `json:"id"`            // id
		Name string `json:"name,optional"` // 名称
		Data string `json:"data,optional"` // 数据
	}

	/* 2 公用类（form） */
	BaseModelForm {
		Id   int64  `form:"id"`            // id
		Name string `form:"name,optional"` // 名称
		Data string `form:"data,optional"` // 数据
	}

	/* 3 公用类 Path */
	PathReq {
		Id   int64  `path:"id"`   // id
		Name string `path:"name"` // 名称
	}

	/* 4 上传文件 */
	FileUploadReq {
		Id       int64   `form:"id"`                // 父级-id
		Type     int64   `form:"type,optional"`     // 类型 1：证书文件；2：私钥文件
		FileList []*byte `form:"fileList,optional"` // 文件列表
	}

	/* 5 下载/预览文件 */
	FileShowReq {
		Id      int64  `form:"id"`               // 文件-id
		FileUrl string `form:"fileUrl,optional"` // 文件地址
	}

	/* 6 用户账号密码登录 model */
	UserModel {
		Account  string `json:"account"`                      // 账号
		Password string `json:"password"`                     // 密码
		Gender   int64  `json:"gender,options=1:2:3"`         // 性别 1：未设置；2：男性；3：女性
		Current  int64  `json:"current,optional,default=1"`   // 当前页码
		PageSize int64  `json:"pageSize,optional,default=20"` // 每页数量


![img](https://img-blog.csdnimg.cn/img_convert/5f48b371a99dda68ad8c825e501436ec.png)
![img](https://img-blog.csdnimg.cn/img_convert/78bc6683b65c0ed08bd7278488ea5cd3.png)

**网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。**

**[需要这份系统化的资料的朋友，可以添加戳这里获取](https://bbs.csdn.net/topics/618658159)**


**一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！**


	UserModel {
		Account  string `json:"account"`                      // 账号
		Password string `json:"password"`                     // 密码
		Gender   int64  `json:"gender,options=1:2:3"`         // 性别 1：未设置；2：男性；3：女性
		Current  int64  `json:"current,optional,default=1"`   // 当前页码
		PageSize int64  `json:"pageSize,optional,default=20"` // 每页数量


[外链图片转存中...(img-fqOfA6Sn-1715503509456)]
[外链图片转存中...(img-Iks58q77-1715503509457)]

**网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。**

**[需要这份系统化的资料的朋友，可以添加戳这里获取](https://bbs.csdn.net/topics/618658159)**


**一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！**