必須使用以下配置開啟swagger服務
@enableswagger2
@configuration
@enableswagger2
public class swaggerconfig implements webmvcconfigurer
private apiinfo apiinfo()
}
@api(tags = "檔案伺服器介面列表")
6.在controller方法中新增方法介面說明
@apioperation("上傳檔案")
當前我的專案 使用的埠為8102 。專案path為 /fileserver
所以我使用路徑為下
http://localhost:port/專案名稱(配置,如無配置則不需要)/doc.html
配置完成
swagger通過註解表明該介面會生成文件,包括介面名、請求方法、引數、返回資訊的等等。
@api:修飾整個類,描述controller的作用
@apioperation:描述乙個類的乙個方法,或者說乙個介面
@apiparam:單個引數描述
@apimodel:用物件來接收引數
@apiproperty:用物件接收引數時,描述物件的乙個字段
@apiresponse:http響應其中1個描述
@apiresponses:http響應整體描述
@apiignore:使用該註解忽略這個api
@apierror :發生錯誤返回的資訊
@apiimplicitparam:乙個請求引數
@apiimplicitparams:多個請求引數
SpringBoot如何優雅地使用Swagger2
spring boot 框架是目前非常流行的微服務框架,我們很多情況下使用它來提供 rest api。而對於 rest api 來說很重要的一部分內容就是文件,swagger 為我們提供了一套通過 和註解自動生成文件的方法,這一點對於保證 api 文件的及時性將有很大的幫助。本文將使用 swagge...
SpringBoot開發案例之整合Swagger篇
前段時間整合過的乙個支付服務,由於使用了spring boot快速開發,但是又懶得寫詳細的文件介紹,便順手就把swagger整合進來了,對支付服務進行分組api展示,如上圖。我有幾張阿里雲幸運券分享給你,用券購買或者公升級阿里雲相應產品會有特惠驚喜哦!把想要買的產品的幸運券都領走吧!快下手,馬上就要...
SpringBoot開發案例之整合Swagger篇
前段時間整合過的乙個支付服務,由於使用了spring boot快速開發,但是又懶得寫詳細的文件介紹,便順手就把swagger整合進來了,對支付服務進行分組api展示,如上圖。swagger 是乙個規範和完整的框架,用於生成 描述 呼叫和視覺化 restful 風格的 web 服務。總體目標是使客戶端...