swag配置

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 標準格式

最后編輯于
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子荐操,更是在濱河造成了極大的恐慌芜抒,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,546評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件托启,死亡現(xiàn)場離奇詭異宅倒,居然都是意外死亡,警方通過查閱死者的電腦和手機驾中,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,224評論 3 395
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來模聋,“玉大人肩民,你說我怎么就攤上這事×捶剑” “怎么了持痰?”我有些...
    開封第一講書人閱讀 164,911評論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長祟蚀。 經(jīng)常有香客問我工窍,道長,這世上最難降的妖魔是什么前酿? 我笑而不...
    開封第一講書人閱讀 58,737評論 1 294
  • 正文 為了忘掉前任患雏,我火速辦了婚禮,結果婚禮上罢维,老公的妹妹穿的比我還像新娘淹仑。我一直安慰自己,他們只是感情好肺孵,可當我...
    茶點故事閱讀 67,753評論 6 392
  • 文/花漫 我一把揭開白布匀借。 她就那樣靜靜地躺著,像睡著了一般平窘。 火紅的嫁衣襯著肌膚如雪吓肋。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,598評論 1 305
  • 那天瑰艘,我揣著相機與錄音是鬼,去河邊找鬼。 笑死紫新,一個胖子當著我的面吹牛屑咳,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播弊琴,決...
    沈念sama閱讀 40,338評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼兆龙,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起紫皇,我...
    開封第一講書人閱讀 39,249評論 0 276
  • 序言:老撾萬榮一對情侶失蹤慰安,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后聪铺,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體化焕,經(jīng)...
    沈念sama閱讀 45,696評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,888評論 3 336
  • 正文 我和宋清朗相戀三年铃剔,在試婚紗的時候發(fā)現(xiàn)自己被綠了撒桨。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,013評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡键兜,死狀恐怖凤类,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情普气,我是刑警寧澤谜疤,帶...
    沈念sama閱讀 35,731評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站现诀,受9級特大地震影響夷磕,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜仔沿,卻給世界環(huán)境...
    茶點故事閱讀 41,348評論 3 330
  • 文/蒙蒙 一坐桩、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧封锉,春花似錦撕攒、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,929評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至闷叉,卻和暖如春擦俐,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背握侧。 一陣腳步聲響...
    開封第一講書人閱讀 33,048評論 1 270
  • 我被黑心中介騙來泰國打工蚯瞧, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人品擎。 一個月前我還...
    沈念sama閱讀 48,203評論 3 370
  • 正文 我出身青樓埋合,卻偏偏與公主長得像,于是被迫代替她去往敵國和親萄传。 傳聞我的和親對象是個殘疾皇子甚颂,可洞房花燭夜當晚...
    茶點故事閱讀 44,960評論 2 355

推薦閱讀更多精彩內(nèi)容