swag配置

swag组成

基本结构（Basic Structure）

API 地址与基本路径（API Host and Base Path）

路径与 *** 作 （Paths and Operations）

参数描述（Describing Parameters）

请求参数描述（Describing Request Body）

返回描述（Describing Responses）

@Param 1参数名 2参数类型 3参数数据类型 4是否必须 5参数描述 6其他属性

参数类型，path ，这个类型表示参数是直接拼接在url里面。

query 表示该参数类型是组合在url中的，对这个理解不了的话主要是对>

当客户端在 发出POST请求时/albums，您希望将请求正文中描述的专辑添加到现有专辑数据中。

为此，您将编写以下内容：

1、编写代码

a添加代码以将专辑数据添加到专辑列表。

在此代码中：

1）用于ContextBindJSON 将请求正文绑定到newAlbum。

2） album将从 JSON 初始化的结构附加到albums 切片。

3）向响应添加201状态代码，以及表示您添加的专辑的 JSON。

b更改您的main函数，使其包含该routerPOST函数，如下所示。

在此代码中：

1）将路径中的POST方法与 /albumspostAlbums函数相关联。

使用 Gin，您可以将处理程序与 >

@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注释

例如：

以上就是关于swag配置全部的内容，包括:swag配置、如何配置go语言开发环境、GO语言（十三）：使用 Go 和 Gin 开发 RESTful API（下）等相关内容解答，如果想了解更多相关内容，可以关注我们，你们的支持是我们更新的动力！