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 标准格式

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 200,667评论 5 472
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,361评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 147,700评论 0 333
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,027评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,988评论 5 361
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,230评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,705评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,366评论 0 255
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,496评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,405评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,453评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,126评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,725评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,803评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,015评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,514评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,111评论 2 341

推荐阅读更多精彩内容