swag組成
基本結構(Basic Structure)
API 地址與基本路徑(API Host and Base Path)
路徑與操作 (Paths and Operations)
參數(shù)描述(Describing Parameters)
請求參數(shù)描述(Describing Request Body)
返回描述(Describing Responses)
@Param 1.參數(shù)名 2.參數(shù)類型 3.參數(shù)數(shù)據(jù)類型 4.是否必須 5.參數(shù)描述 6.其他屬性
參數(shù)類型邻耕,path. 媒惕,這個類型表示參數(shù)是直接拼接在url里面。
query 表示該參數(shù)類型是組合在url中的站故,對這個理解不了的話主要是對http.參數(shù)類型的概念理解不到位轨蛤,首先來看一下HTTP 參數(shù)類型簡介
請求頭參數(shù) (head)
路徑參數(shù) (path)
查詢參數(shù) (query)
請求體參數(shù) (body)
http協(xié)議 傳參類型 根據(jù)參數(shù)所在位置不同朝氓,
可以看一下再參數(shù)取出來時候的差別HTTP 參數(shù)類型簡介
請求頭參數(shù) (head)
路徑參數(shù) (path)
查詢參數(shù) (query)
請求體參數(shù) (body)
http協(xié)議 傳參類型 根據(jù)參數(shù)所在協(xié)議中的位置可以分為四大類缸逃,請求頭參數(shù)就是一般我們在http中調(diào)用經(jīng)常指定的少辣,比如header為accept-類型耕突,json form之類的饶氏,告訴服務端我這次請求的內(nèi)容是什么。
路徑參數(shù)有勾,就是把要查詢的資源名字直接放在路徑中疹启,比如get某些城市的接口,直接把參數(shù)城市名字放入到url中蔼卡,這種請求風格正是testful風格使用的喊崖。
www.test.com/get/xian
查詢參數(shù),就是我們常見的get請求url地址雇逞?問號后面帶的參數(shù)荤懂,是以value=key的形式出現(xiàn)的,這種參數(shù)請求是通常使用的一種方式
www.test.com/get塘砸?city=xian
go中取這個參數(shù)的方式
city := c.Query("city")
請求體參數(shù)顧名思義节仿,是存放在請求體中發(fā)送給服務器的參數(shù)。請求體參數(shù)格式復雜多變掉蔬,服務器會先根據(jù)請求頭中的 Content-Type 獲取其格式廊宪,然后再根據(jù)其格式進行解析,常見的格式如下:
Content-Type值 內(nèi)容格式 消息示例
application/from 表單傳值女轿,也是默認的解析形式,服務器會對表單進行解析 userId=1&userId=1&age=18&sex=男
text/plain 文本值箭启,服務器會將本次請求的請求體當作普通字符串看待 Hello world
application/json json,服務器會將請求體進行json解析,獲取參數(shù) {“userId”:1,“sex”:“男”}
application/xml xml,服務器會將請求體進行xml解析蛉迹,獲取參數(shù) 參見 xml 標準格式
text/html html,服務器會將請求體進行html解析傅寡,獲取參數(shù) 參見 html 標準格式