一 Swagger2 介绍

1 什么是swagger2

编写和维护接口文档是每个程序员的职责，根据 Swagger2 可以快速帮助我们编写最新的 API 接口文档，再也不用担心开会前仍忙于整理各种资料了，间接提升了团队开发的沟通效率。

2 常用注解

swagger 通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。

@Api：修饰整个类，描述 Controller 的作用
@ApiOperation：描述一个类的一个方法，或者说一个接口
@ApiParam：单个参数描述
@ApiModel：用对象来接收参数
@ApiModelProperty：用对象接收参数时，描述对象的一个字段
@ApiImplicitParam：一个请求参数
@ApiImplicitParams：多个请求参数

二 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("网站-API文档").description("本文档描述了网站微服务接口定义").version("1.0").contact(new Contact("baiyee", "http://www.baiyee.cn/", "798103175@qq.com")).build();}private ApiInfo adminApiInfo() {return new ApiInfoBuilder().title("后台管理系统-API文档").description("本文档描述了后台管理系统微服务接口定义").version("1.0").contact(new Contact("baiyee", "http://www.baiyee.cn/", "798103175@qq.com")).build();}
}

3 给控制器加上 swagger 的注解

// 查询医院所有信息
@ApiOperation(value = "获取所有医院")
@GetMapping("findAll")
public Result findAllHospitalSet() {// 调用 service 的方法List<Hospital> list = hospitalService.list();return Result.ok(list);
}// 逻辑删除医院
@ApiOperation(value = "逻辑删除医院")
@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 逻辑删

逻辑删后，数据库表结果

用 Swagger 测试任务分配问题中的 API相关推荐

浅析如何在Nancy中生成API文档
前言前后端分离,或许是现如今最为流行开发方式,包括UWP.Android和IOS这样的手机客户端都是需要调用后台的API来进行数据的交互. 但是这样对前端开发和APP开发就会面临这样一个问题:如何知 ...
使用Swagger服务搭建.Net Core API
使用Swagger服务搭建.Net Core API 创建.Net Core API 新建项目.文件--新建--项目选择应用程序模板. 设置存放路径,命名方案名称. 创建API. 搭建成功. 使用S ...
如何在.NET Core中创建API
目录实现目标什么是API? 什么是JSON? 步骤1:运行Dotnet命令步骤2:探索您的项目步骤3:设定环境步骤4:建立模型步骤5:创建控制器第6步:将Swagger添加到您的项目步 ...
swagger -- 前后端分离的API接口
文章目录一.背景二.swagger介绍三.在maven+springboot项目中使用swagger 四.swagger在项目中的好处五.美化界面参考链接: 5分钟学会swagger配置参 ...
tensorflow2.0中dataset API 总结
tensorflow2.0中data API 总结 tf.data.Dataset.list_files(filename) 参数:filename:文件路径或者文件路径列表,如:'-/csvData ...
[转]在C#中使用API回调函数的方法
在C#中使用API回调函数的方法就以EnumChildWindows和EnumChildProc为例子: 首先要声明EnumChildProc 为一个回调函数 public delegate boo ...
在使用postman中操作api接口测试403解决方法
在使用postman中操作api接口测试403解决方法参考文章: (1)在使用postman中操作api接口测试403解决方法 (2)https://www.cnblogs.com/xiaoyayu ...
shellcode中动态定位API
定位API的原理: 所有的win_32程序都会加载ntdll.dll和kerner32.dll这两个最基础的动态链接库.如果想要在win_32平台下定位kernel32.dll中的API地址 1,首先 ...
appium 中部分 api 的使用方法
使用的语言是java,appium的版本是1.3.4,java-client的版本是java-client-2.1.0,建议多参考java-client-2.1.0-javadoc. 1.使用Andr ...

用 Swagger 测试任务分配问题中的 API