swag組成

基本結(jié)構(gòu)(Basic Structure)
API 地址與基本路徑(API Host and Base Path)
路徑與操作 (Paths and Operations)
參數(shù)描述(Describing Parameters)
請(qǐng)求參數(shù)描述(Describing Request Body)
返回描述(Describing Responses)
@Param 1.參數(shù)名 2.參數(shù)類型 3.參數(shù)數(shù)據(jù)類型 4.是否必須 5.參數(shù)描述 6.其他屬性
參數(shù)類型,path. ,這個(gè)類型表示參數(shù)是直接拼接在url里面。
query 表示該參數(shù)類型是組合在url中的,對(duì)這個(gè)理解不了的話主要是對(duì)http.參數(shù)類型的概念理解不到位,首先來(lái)看一下HTTP 參數(shù)類型簡(jiǎn)介
請(qǐng)求頭參數(shù) (head)
路徑參數(shù) (path)
查詢參數(shù) (query)
請(qǐng)求體參數(shù) (body)
http協(xié)議 傳參類型 根據(jù)參數(shù)所在位置不同,
可以看一下再參數(shù)取出來(lái)時(shí)候的差別HTTP 參數(shù)類型簡(jiǎn)介
請(qǐng)求頭參數(shù) (head)
路徑參數(shù) (path)
查詢參數(shù) (query)
請(qǐng)求體參數(shù) (body)
http協(xié)議 傳參類型 根據(jù)參數(shù)所在協(xié)議中的位置可以分為四大類,請(qǐng)求頭參數(shù)就是一般我們?cè)趆ttp中調(diào)用經(jīng)常指定的,比如header為accept-類型,json form之類的,告訴服務(wù)端我這次請(qǐng)求的內(nèi)容是什么。
路徑參數(shù),就是把要查詢的資源名字直接放在路徑中,比如get某些城市的接口,直接把參數(shù)城市名字放入到url中,這種請(qǐng)求風(fēng)格正是testful風(fēng)格使用的。
www.test.com/get/xian
查詢參數(shù),就是我們常見(jiàn)的get請(qǐng)求url地址?問(wèn)號(hào)后面帶的參數(shù),是以value=key的形式出現(xiàn)的,這種參數(shù)請(qǐng)求是通常使用的一種方式
www.test.com/get?city=xian
go中取這個(gè)參數(shù)的方式
city := c.Query("city")
請(qǐng)求體參數(shù)顧名思義,是存放在請(qǐng)求體中發(fā)送給服務(wù)器的參數(shù)。請(qǐng)求體參數(shù)格式復(fù)雜多變,服務(wù)器會(huì)先根據(jù)請(qǐng)求頭中的 Content-Type 獲取其格式,然后再根據(jù)其格式進(jìn)行解析,常見(jiàn)的格式如下:
Content-Type值 內(nèi)容格式 消息示例
application/from 表單傳值,也是默認(rèn)的解析形式,服務(wù)器會(huì)對(duì)表單進(jìn)行解析 userId=1&userId=1&age=18&sex=男
text/plain 文本值,服務(wù)器會(huì)將本次請(qǐng)求的請(qǐng)求體當(dāng)作普通字符串看待 Hello world
application/json json,服務(wù)器會(huì)將請(qǐng)求體進(jìn)行json解析,獲取參數(shù) {“userId”:1,“sex”:“男”}
application/xml xml,服務(wù)器會(huì)將請(qǐng)求體進(jìn)行xml解析,獲取參數(shù) 參見(jiàn) xml 標(biāo)準(zhǔn)格式
text/html html,服務(wù)器會(huì)將請(qǐng)求體進(jìn)行html解析,獲取參數(shù) 參見(jiàn) html 標(biāo)準(zhǔn)格式