Swagger 的基本使用

在專案中使用 swagger ：

新建乙個 springboot web 專案

匯入相關依賴

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

編寫乙個 hello 工程

@restcontroller

public
class
hellocontroller
}

@configuration

@enableswagger2
// 開啟 swagger2
public
class
swaggerconfig

swagger 的 bean 例項 docket；

@configuration

@enableswagger2
// 開啟 swagger2
public
class
swaggerconfig
// 配置 swagger 資訊 ==> apiinfo
private apiinfo apiinfo()
}

// 配置 swagger 的 docket 的 bean 例項

@bean
public docket docket()

// 配置 swagger 的 docket 的 bean 例項

@bean
public docket docket()

注：此處使用的 dev 埠是 8081

server.port=8081

// 配置 swagger 的 docket 的 bean 例項

@bean
public docket docket
(environment environment)

spring.profiles.active=dev

配置 api 文件的分組

.

groupname
("分組"
)

多個 docket 例項即可！

@bean

public docket docket1()
@bean
public docket docket2()
@bean
public docket docket3()

實體類

@apimodel

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

@restcontroller

public
class
hellocontroller
// 只要介面中返回值存在實體類，就會被掃瞄到 swagger 中
("/user"
)public user user()
@apioperation
("hello2 控制類")(
"/hello2"
)public string hello2
(@apiparam
("使用者名稱"
) string username)
}

我們可以通過 swagger 給一些比較難理解的屬性或者介面，增加注釋資訊

介面文件實時更新

注意點：在正式發布的時候，關閉 swagger！！！

Swagger基本使用

引入swagger的依賴 io.springfox springfox swagger2 2.9.2 io.springfox springfox swagger ui 2.9.2 2.x版本會報錯numberformatexception，更改版本即可解決 io.swagger swagger a...

Swagger2的基本了解和使用

toc 中極篇 一篇不錯的文章，從基礎到配置到實現寫的很詳細。傳送們 高階篇 mall作者，我從他這學到不少東西，非常感謝！傳送們 註解說明 api 用於修飾controller類，生成controller相關文件資訊 apioperation 用於修飾controller類中的方法，生成介面方法相...

swagger註解的使用

apiimplicitparams 5.apiresponses 用於表示一組響應 6.apiresponse 用在 apiresponses中，一般用於表達乙個錯誤的響應資訊 code 數字，例如400 message 資訊，例如 請求引數沒填好 response 丟擲異常的類 apirespon...