Swagger2的基本了解和使用

[[toc]]

中極篇：一篇不錯的文章，從基礎到配置到實現寫的很詳細。傳送們

高階篇：mall作者，我從他這學到不少東西，非常感謝！傳送們

註解說明

@api

用於修飾controller類，生成controller相關文件資訊

@apioperation

用於修飾controller類中的方法，生成介面方法相關文件資訊

@apiparam

用於修飾介面中的引數，生成介面引數相關文件資訊

@apimodel

用於修飾model實體類

@apimodelproperty

用於修飾model實體類的屬性，當實體類是請求引數或返回結果時，直接生成相關文件資訊

[外鏈轉存失敗,源站可能有防盜煉機制,建議將儲存下來直接上傳(img-mgen0pg3-1593402626340)(/znote/img/swagger2/swagger2.png)]

>
>
io.springfoxgroupid
>
>
springfox-swagger2artifactid
>
>
2.9.2version
>
dependency
>
>
>
io.springfoxgroupid
>
>
springfox-swagger-uiartifactid
>
>
2.9.2version
>
dependency
>

@configuration

//這是乙個配置類
@enableswagger2
//開啟swagger2的自動配置
public
class
swagger2config
//不是剛需，按需配置
private apiinfo apiinfo()
}

@controller

@api
(tags =
"omsordersettingcontroller"
, description =
"訂單設定管理")(
"/ordersetting"
)public
class
omsordersettingcontroller
", method = requestmethod.get)
@responsebody
public commonresult
getitem
(@pathvariable long id)
@apioperation
("修改指定訂單設定"
)(value =
"/update/"
, method = requestmethod.post)
@responsebody
public commonresult update
(@pathvariable long id,
@requestbody omsordersetting ordersetting)
return commonresult.
failed()
;}}

@apimodel

("使用者實體"
)public
class
user

springboot與swagger2的整合

現在測試都提倡自動化測試，那我們作為後台的開發人員，也得進步下啊，以前用postman來測試後台介面，那個麻煩啊，乙個字母輸錯就導致測試失敗，現在swagger的出現可謂是拯救了這些開發人員，便捷之處真的不是一點兩點。下面我們看下如何在微服務中將springboot與swagger來結合吧。1 sw...

swagger2的詳細筆記

swagger2 是乙個規範和完整的框架，用於生成 描述 呼叫和視覺化restful風格的web服務。介面文件對於前後端開發人員都非常重要。swagger可以使得介面文件動態生成 openapi 是rest api的api描述格式 open api規範可以使用yaml或json格式進行編寫。open...

swagger2的介面文件

以前見過乙個swagger2的介面文件，特別好用，好看，對介面中入參描述的很詳細 適合用於專案的開發 後來自己做專案的時候，沒有找到這個swagger版本 io.springfox springfox swagger2 2.9.2 io.springfox springfox swagger ui ...