常用字段說明
| 字段 |
說明 |
schemes |
使用協議（如：http、https） |
host |
項目地址，這個地址會作為每個接口的url base，拼接起來一起作為防偽地址 |
consumes |
接口默認接收的MIME類型（如：formData） |
produces |
接口默認返回MIME類型。api接口用的比較多的是 application/json 和 application/xml |
summary |
接口的簡要介紹，會顯示在接口標頭上，不能超過120個字符 |
description |
接口的詳細介紹 |
externalDocs |
外部文檔連接 |
operationId |
全局唯一的接口標識 |
parameters |
參數列表 |
@SWG\Info |
此項填寫的內容會放在文檔開頭，用作文檔說明 |
@SWG\TAG |
tag是用來給文檔分類的，name字段必須唯一，某個接口可以指定多個tag，那它就會出現在多組分類中（tag也可以不用在這里預先定義） |
@SWG\Get |
通過get的方式請求數據 |
@SWG\Post |
通過post的方式請求數據 |
@SWG\Parameter常用字段說明
| 字段 |
說明 |
name |
參數名 |
in |
參數的來源，必填，取值范圍：query、header、path、formData、body |
description |
參數描述 |
type |
參數類型，取值范圍：string、number、integer、boolean、array、file |
required |
參數是否必須，取值范圍：true、false (通過路徑傳參in="path"時必須為true) |
default |
參數的默認值 |
傳送門
swagger官方文檔
swagger從入門到精通
