三、在模組service-base中,建立swagger的配置類
四、在模組service模組中引入service-base
五、在service-edu啟動類上新增註解,進行測試
六、api模型
七、定義介面說明和引數說明
2.方便介面測試
前後端分離開發模式中,api文件是最好的溝通方式。
swagger 是乙個規範和完整的框架,用於生成、描述、呼叫和視覺化 restful 風格的 web 服務。
及時性 (介面變更後,能夠及時準確地通知相關前後端開發人員)在guli-parent下建立模組common規範性 (並且保證介面的規範性,如介面的位址,請求方式,引數及響應格式和錯誤資訊)
一致性 (介面資訊一致,不會出現因開發人員拿到的文件版本不一致,而出現分歧)
可測性 (直接在介面文件上進行測試,以方便理解業務)
配置:
groupid:com.atguigu
!--lombok用來簡化實體類:需要安裝lombok外掛程式--
>
org.projectlombok<
/groupid>
lombok<
/artifactid>
provided <
/scope>
<
/dependency>
<
!--swagger--
>
io.springfox<
/groupid>
springfox-swagger2<
/artifactid>
provided <
/scope>
<
/dependency>
io.springfox<
/groupid>
springfox-swagger-ui<
/artifactid>
provided <
/scope>
<
/dependency>
<
!-- redis --
>
org.springframework.boot<
/groupid>
spring-boot-starter-data-redis<
/artifactid>
<
/dependency>
<
!-- spring2.x整合redis所需common-pool2
org.apache.commons<
/groupid>
commons-pool2<
/artifactid>
2.6.0
<
/version>
<
/dependency>
-->
<
/dependencies>
建立包com.atguigu.servicebase.config,建立類swaggerconfig
可以新增一些自定義設定,例如:
定義樣例資料
@apimodelproperty
(value =
"建立時間"
, example =
"2019-01-01 8:00:00"
)@tablefield
(fill = fieldfill.insert)
private date gmtcreate;
@apimodelproperty
(value =
"更新時間"
, example =
"2019-01-01 8:00:00"
)@tablefield
(fill = fieldfill.insert_update)
private date gmtmodified;
定義在類上:@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)
}
SpringBoot整合Swagger生成文件
swagger是啥?這個不多比比,也許你們比我還了解,介面文件如何生成?為了不浪費各位看官的時間,直接上流程!一 新增依賴 二 建立swagger2配置類 swagger2配置類 通過 configuration註解,讓spring來載入該類配置。再通過 enableswagger2註解來啟用swa...
SpringBoot整合swagger介面開發
1.在自己的專案pom檔案裡面必須要新增的兩個依賴 io.springfox springfox swagger2 2.9.2 io.springfox springfox swagger ui 2.9.2 2.新增配置檔案,在配置類裡面新增 configuration enableswagger2...
swagger整合到springBoot 專案中
1 pom 檔案加包依賴 io.springfox springfox swagger2 2.2.2 io.springfox springfox swagger ui 2.2.2 2 啟動類加上註解 enableswagger 啟動該註解使得用在controller中的swagger註解生效,覆蓋...