常用字段說明
| 字段 | 說明 |
|---|---|
schemes |
使用協(xié)議（如：http、https） |
host |
項(xiàng)目地址升薯，這個(gè)地址會(huì)作為每個(gè)接口的url base，拼接起來一起作為防偽地址 |
consumes |
接口默認(rèn)接收的MIME類型（如：formData） |
produces |
接口默認(rèn)返回MIME類型嘹吨。api接口用的比較多的是 application/json 和 application/xml
|
summary |
接口的簡要介紹，會(huì)顯示在接口標(biāo)頭上插龄，不能超過120個(gè)字符 |
description |
接口的詳細(xì)介紹 |
externalDocs |
外部文檔連接 |
operationId |
全局唯一的接口標(biāo)識(shí) |
parameters |
參數(shù)列表 |
@SWG\Info |
此項(xiàng)填寫的內(nèi)容會(huì)放在文檔開頭刽肠，用作文檔說明 |
@SWG\TAG |
tag是用來給文檔分類的纯命，name字段必須唯一，某個(gè)接口可以指定多個(gè)tag损俭，那它就會(huì)出現(xiàn)在多組分類中（tag也可以不用在這里預(yù)先定義） |
@SWG\Get |
通過get的方式請(qǐng)求數(shù)據(jù) |
@SWG\Post |
通過post的方式請(qǐng)求數(shù)據(jù) |
@SWG\Parameter常用字段說明
| 字段 | 說明 |
|---|---|
name |
參數(shù)名 |
in |
參數(shù)的來源蛙奖，必填，取值范圍：query杆兵、header雁仲、path、formData琐脏、body
|
description |
參數(shù)描述 |
type |
參數(shù)類型攒砖，取值范圍：string、number日裙、integer祭衩、boolean、array阅签、file
|
required |
參數(shù)是否必須掐暮，取值范圍：true、false (通過路徑傳參in="path"時(shí)必須為true) |
default |
參數(shù)的默認(rèn)值 |
