SpringBoot專案整合Swagger2

swagger 是最流行的 api 開發工具，它遵循 openapi specification（openapi 規範，也簡稱 oas）。

swagger 可以貫穿於整個 api 生態，如 api 的設計、編寫 api 文件、測試和部署。

swagger 是一種通用的，和程式語言無關的 api 描述規範。

很多時候自己手動維護乙份api文件需要花費大量的時間和精力;而且常常會因為一些的臨時的、不在計畫內的api修改後忘記更新api文件影響前端開發;前端程式設計師不能及時獲取到最新的的api文件等等問題,而swagger能解決這個問題.

io.springfox springfox-swagger2 2.6.1 io.springfox springfox-swagger-ui 2.6.1

import org.springframework.context.annotation.bean;
import org.springframework.context.annotation.configuration;
import springfox.documentation.builders.apiinfobuilder;
import springfox.documentation.builders.pathselectors;
import springfox.documentation.builders.requesthandlerselectors;
import springfox.documentation.service.apiinfo;
import springfox.documentation.spi.documentationtype;
import springfox.documentation.spring.web.plugins.docket;
/** * @author vic.douglas
* @date 2019-06-19 22:12:31
*/@configuration
public class swagger2 
private apiinfo apiinfo() 
}

@api：用在請求的類上，表示對類的說明 tags="說明該類的作用，可以在ui介面上看到的註解" value="該引數沒什麼意義，在ui介面上也看到，所以不需要配置" @apioperation：用在請求的方法上，說明方法的用途、作用 value="說明方法的用途、作用" notes="方法的備註說明" @apiimplicitparams：用在請求的方法上，表示一組引數說明 @apiimplicitparam：用在@apiimplicitparams註解中，指定乙個請求引數的各個方面 name：引數名 value：引數的漢字說明、解釋 required：引數是否必須傳 paramtype：引數放在哪個地方 · header --> 請求引數的獲取：@requestheader · query --> 請求引數的獲取：@requestparam · path（用於restful介面）--> 請求引數的獲取：@pathvariable · body（不常用） · form（不常用） datatype：引數型別，預設string，其它值datatype="integer" defaultvalue：引數的預設值 @apiresponses：用在請求的方法上，表示一組響應 @apiresponse：用在@apiresponses中，一般用於表達乙個錯誤的響應資訊 code：數字，例如400 message：資訊，例如"請求引數沒填好" response：丟擲異常的類 @apimodel：用於響應類上，表示乙個返回響應資料的資訊（這種一般用在post建立的時候，使用@requestbody這樣的場景，請求引數無法使用@apiimplicitparam註解進行描述的時候） @apimodelproperty：用在屬性上，描述響應類的屬性

@api(value = "商戶型別",tags = "商戶型別")
@restcontroller
public class shopclassifycontroller 
return redistemplate.opsforvalue().get("shopclassify");
}

輸入localhost:port/swagger-ui.html,效果如下

SpringBoot專案整合Swagger2

springboot專案整合vue

springboot專案整合shiro

SpringBoot專案整合Swagger UI

SpringBoot專案整合Swagger2

springboot專案整合vue

springboot專案整合shiro

SpringBoot專案整合Swagger UI

相關推薦