golang的swagger注解

Posted 2023-05-13

参考技术A

@Tags : 分类信息
例如：

@Summary ： 操作的简短摘要。
例如：

@Description ： 操作的详细说明。
例如：

@Param ：参数信息，用空格分隔的参数。param name,param type,data type,is mandatory?,comment attribute(optional)
1.参数名
2.参数类型，可以有的值是 formData、query、path、body、header，formData 表示是 post 请求的数据，query 表示带在 url 之后的参数，path 表示请求路径上得参数，例如上面例子里面的 key，body 表示是一个 raw 数据请求，header 表示带在 header 信息中得参数。
3.参数类型
4.是否必须
5.注释
例如：

Swagger笔记之Swagger注解

参考技术A @ TOC

api 标记，用在类上，说明该类的作用。可以标记一个 Controller 类做为 Swagger 文档资源，使用方式

与 Controller 注解并列使用。 属性配置：

tags 一定要写，不然swagger扫描显示的是类名

ApiOperation 标记，用在方法上，说明方法的作用，每一个 url 资源的定义,使用方式：

与 Controller 中的方法并列使用，属性配置：

ApiParam 标记，请求属性，使用方式：

与Controller中的方法并列使用，属性配置：

ApiResponse 标记，响应配置，使用方式：

与 Controller 中的方法并列使用，属性配置：

ApiResponses 标记，响应集配置，使用方式:

与 Controller 中的方法并列使用，属性配置：

ResponseHeader 标记，响应头设置，使用方法

与 Controller 中的方法并列使用，属性配置：

其中@Null、@NotNull。。等与@Valiated 配合使用

用在返回对象类上

用在返回对象的属性上

@Api(tags = "")写，不然swagger扫描显示的是类名

持续更新中。。。。