05 配置Swagger2生成API介面文件

前後端分離開發模式中，api文件是最好的溝通方式。

swagger 是乙個規範和完整的框架，用於生成、描述、呼叫和視覺化 restful 風格的 web 服務。

規範性(並且保證介面的規範性，如介面的位址，請求方式，引數及響應格式和錯誤資訊)

一致性(介面資訊一致，不會出現因開發人員拿到的文件版本不一致，而出現分歧)

可測性 (直接在介面文件上進行測試，以方便理解業務)

在guli-parent下建立模組common

配置：groupid：com.atguigu

建立包com.atguigu.servicebase.config，建立類swaggerconfig

可以新增一些自定義設定，例如：

定義樣例資料

@apimodelproperty

(value =
"建立時間"
, example =
"2019-01-01 8:00:00"
)@tablefield
(fill = fieldfill.insert)
private date gmtcreate;
@apimodelproperty
(value =
"更新時間"
定義在類上：@api

定義在方法上：@apioperation
定義在引數上：@apiparam
@api

(description=
"講師管理"
)@restcontroller
("/admin/edu/teacher"
)public
class
teacheradmincontroller
@apioperation
(value =
"根據id刪除講師")(
"")public
boolean
removebyid
(@apiparam
(name =
"id"
, value =
"講師id"
, required =
true
)@pathvariable string id)
}
 
swagger2 生成介面文件步驟
匯入jar包 swagger2 io.springfox groupid springfox swagger2 artifactid dependency 防止進入swagger頁面報型別轉換錯誤，排除2.9 2中的引用，手動增加1.5 21版本 io.swagger groupid swagger...
匯出swagger2生成的文件
沒錯這個專案就是專門根據json解析生成文件的。二 修改配置 解壓專案，並且用idea開啟。啟動要生成文件的專案，前提這個專案整合了swagger2，瀏覽 http localhost 8080 swagger ui.html 輸入 http localhost 8080 v2 api docs 儲...
swagger2配置詳解
api tags 使用者相關介面 description 提供使用者相關的 rest api public class usercontroller屬性解析 註解屬性 型別描述 br 控制器標籤。description string 控制器描述 該字段被申明為過期 apioperation 主要屬性...