Swagger基本使用

2021-10-05 10:04:02 字數 830 閱讀 9010

引入swagger的依賴

io.springfox

springfox-swagger2

2.9.2

io.springfox

springfox-swagger-ui

2.9.2

2.x版本會報錯numberformatexception,更改版本即可解決

io.swagger

swagger-annotations

1.5.22

io.swagger

swagger-models

1.5.22

1、配置swagger的配置檔案,標註@configuration註解

2、在主配置類上開啟自動配置,標註@enableswagger2

3、啟動專案訪問/swagger-ui.html

1、預設swagger有乙個例項docket

2、建立乙個bean覆蓋預設的

@bean

public docket docket()

public apiinfo apiinfo()

description已被棄用

@apioperation 用於方法上 示例:@apioperation("***操作")

@apiparam 用於方法的引數上 示例:@apiparam(name="***屬性",value="***格式",required=true)

@apimodel 用於實體類上

@apimodelproperty 用於實體類屬性上

Swagger 的基本使用

在專案中使用 swagger 新建乙個 springboot web 專案 匯入相關依賴 io.springfoxgroupid springfox swagger2artifactid 2.9.2version dependency io.springfoxgroupid springfox sw...

swagger使用詳解

swagger 的目標是為rest apis 定義乙個標準的,與語言無關的介面,使人和計算機在看不到原始碼或者看不到文件或者不能通過網路流量檢測的情況下能發現和理解各種服務的功能。當服務通過swagger定義,消費者就能與遠端的服務互動通過少量的實現邏輯。類似於低階程式設計介面,swagger去掉了...

Swagger 註解使用

首先我們通過swagger的原始碼可以看到有很多的註解,下面這張截圖應該可以包括swagger的所有註解。註解名稱 使用說明 api api 用在類上,說明該類的作用。可以標記乙個 controller 類作為 swagger 文件資源,所以一般用在controller介面中,在swagger頁面上...