一?Swagger2 介紹

1 什么是swagger2

編寫和維護接口文檔是每個程序員的職責(zé)，根據(jù) Swagger2 可以快速幫助我們編寫最新的 API 接口文檔，再也不用擔(dān)心開會前仍忙于整理各種資料了，間接提升了團隊開發(fā)的溝通效率。

2 常用注解

swagger 通過注解表明該接口會生成文檔，包括接口名、請求方法、參數(shù)、返回信息的等等。

• @Api：修飾整個類，描述 Controller 的作用

• @ApiOperation：描述一個類的一個方法，或者說一個接口

• @ApiParam：單個參數(shù)描述

• @ApiModel：用對象來接收參數(shù)

• @ApiModelProperty：用對象接收參數(shù)時，描述對象的一個字段

• @ApiImplicitParam：一個請求參數(shù)

• @ApiImplicitParams：多個請求參數(shù)

二?Swagger2 集成

1 項目整合?Swagger2

在 common 模塊 pom.xml 引入依賴

<!-- swagger --> <dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId> </dependency> <dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId> </dependency>

說明：在 sdgt-parent 中的 pom.xml 中添加了版本控制，這里不需要添加版本。

2??添加 swagger2 配置類

在 service-util 模塊添加配置類

/** * @className: Swagger2Config * @description: Swagger2配置信息 * @date: 2021/10/4 * @author: cakin */ @Configuration @EnableSwagger2 public class Swagger2Config {@Beanpublic Docket webApiConfig() {return new Docket(DocumentationType.SWAGGER_2).groupName("webApi").apiInfo(webApiInfo()).select()// 只顯示api路徑下的頁面.paths(Predicates.and(PathSelectors.regex("/api/.*"))).build();}@Beanpublic Docket adminApiConfig() {return new Docket(DocumentationType.SWAGGER_2).groupName("adminApi").apiInfo(adminApiInfo()).select()// 只顯示 admin 路徑下的頁面.paths(Predicates.and(PathSelectors.regex("/admin/.*"))).build();}private ApiInfo webApiInfo() {return new ApiInfoBuilder().title("網(wǎng)站-API文檔").description("本文檔描述了網(wǎng)站微服務(wù)接口定義").version("1.0").contact(new Contact("baiyee", "http://www.baiyee.cn/", "798103175@qq.com")).build();}private ApiInfo adminApiInfo() {return new ApiInfoBuilder().title("后臺管理系統(tǒng)-API文檔").description("本文檔描述了后臺管理系統(tǒng)微服務(wù)接口定義").version("1.0").contact(new Contact("baiyee", "http://www.baiyee.cn/", "798103175@qq.com")).build();} }

3?給控制器加上?swagger 的注解

// 查詢醫(yī)院所有信息 @ApiOperation(value = "獲取所有醫(yī)院") @GetMapping("findAll") public Result findAllHospitalSet() {// 調(diào)用 service 的方法List<Hospital> list = hospitalService.list();return Result.ok(list); }// 邏輯刪除醫(yī)院 @ApiOperation(value = "邏輯刪除醫(yī)院") @DeleteMapping("{id}") public Result removeHospSet(@PathVariable String id) {boolean flag = hospitalService.removeById(id);if (flag) {return Result.ok();} else {return Result.fail();} }

4?使用 swagger2 測試

a 主頁面

b 查詢

c 邏輯刪

邏輯刪后，數(shù)據(jù)庫表結(jié)果

總結(jié)

以上是生活随笔為你收集整理的用 Swagger 测试任务分配问题中的 API的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。