使用swagger生成restful風格的介面文件

專案中如何配置swagger？下方鏈結

springboot整合swagger

匯入依賴

>

>
org.projectlombokgroupid
>
>
lombokartifactid
>
>
1.16.18version
>
>
providedscope
>
dependency
>
>
>
io.springfoxgroupid
>
>
springfox-swagger-uiartifactid
>
>
2.9.2version
>
dependency
>
>
>
io.springfoxgroupid
>
>
springfox-swagger2artifactid
>
>
2.9.2version
>
dependency
>

@configuration

@enableswagger2
public
class
swaggerconfig
//配置swagger資訊
private apiinfo apiinfo()
}

@getter

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

@restcontroller

@api
(tags =
)public
class
usercontroller")
@apioperation
(value =
"根據id查詢使用者"
)//這裡可以使用這句話注釋也可以使用@apiparam
//@apiimplicitparam(name = "id",value = "使用者id",required = true,datatype = "int")
public string userlist
(@apiparam
("使用者id"
)@pathvariable
int id)
("/user"
)@apioperation
(value =
"新增使用者"
)public string adduser
(@apiparam
("使用者物件"
) user user)
("/user/"
)@apioperation
(value =
"修改使用者資訊"
)public string updateuser
(@apiparam
("使用者id"
)@pathvariable
int id,
@apiparam
("使用者物件"
) user user)
("/user/"
)@apioperation
(value =
"刪除使用者"
)public string deleteuser
(@apiparam
("使用者id"
)@pathvariable
int id)
}

瀏覽器輸入http://localhost:8080/swagger-ui.html

最終效果：

什麼是restful? 對restful的理解

使用swagger生成API文件

有時候乙份清晰明了的介面文件能夠極大地提高前後端雙方的溝通效率和開發效率。本文將介紹如何使用swagger生成介面文件。swagger本質上是一種用於描述使用json表示的restful api的介面描述語言。swagger與一組開源軟體工具一起使用，以設計 構建 記錄和使用restful web服...

使用Swagger自動生成文件

swagger 是乙個規範和完整的框架，用於生成 描述 呼叫和視覺化 restful 風格的 web 服務。springfox 的前身是 swagger springmvc，是乙個開源的 api doc 框架，可以將我們的 controller 的方法以文件的形式展現，基於 swagger。官網 第...

Go語言使用swagger生成介面文件

本文首發於我的個人部落格 liwenzhou.com，更多更詳細的go語言專案實戰內容就在liwenzhou.com。swagger本質上是一種用於描述使用json表示的restful api的介面描述語言。swagger與一組開源軟體工具一起使用，以設計 構建 記錄和使用restful web服務...