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中的，对这个理解不了的话主要是对http.参数类型的概念理解不到位，首先来看一下HTTP 参数类型简介

请求头参数 （head）

路径参数 （path）

查询参数 （query）

请求体参数 （body）

http协议 传参类型 根据参数所在位置不同，

可以看一下再参数取出来时候的差别HTTP 参数类型简介

请求头参数 （head）

路径参数 （path）

查询参数 （query）

请求体参数 （body）

http协议 传参类型 根据参数所在协议中的位置可以分为四大类，请求头参数就是一般我们在http中调用经常指定的，比如header为accept-类型，json form之类的，告诉服务端我这次请求的内容是什么。

路径参数，就是把要查询的资源名字直接放在路径中，比如get某些城市的接口，直接把参数城市名字放入到url中，这种请求风格正是testful风格使用的。

www.test.com/get/xian

查询参数，就是我们常见的get请求url地址？问号后面带的参数，是以value=key的形式出现的，这种参数请求是通常使用的一种方式

www.test.com/get？city=xian

go中取这个参数的方式

city := c.Query("city")

请求体参数顾名思义，是存放在请求体中发送给服务器的参数。请求体参数格式复杂多变，服务器会先根据请求头中的 Content-Type 获取其格式，然后再根据其格式进行解析，常见的格式如下：

Content-Type值 内容格式 消息示例

application/from 表单传值，也是默认的解析形式,服务器会对表单进行解析 userId=1&userId=1&age=18&sex=男

text/plain 文本值，服务器会将本次请求的请求体当作普通字符串看待 Hello world

application/json json,服务器会将请求体进行json解析，获取参数 {“userId”:1,“sex”:“男”}

application/xml xml,服务器会将请求体进行xml解析，获取参数 参见 xml 标准格式

text/html html,服务器会将请求体进行html解析，获取参数 参见 html 标准格式