使激活的环境设置测试环境----》8080端口，会不启动swagger
切换成开发环境 dev 8081
⭐6.配置API文档分组
这样的目的就是我们可以协同合作，分组操作
1、如果没有配置分组，默认是default。通过groupName()方法即可配置分组：
@Bean public Docket docket(Environment environment) { // 设置要显示的swagger环境 Profiles profiles = Profiles.of("dev"); // environment.acceptsProfiles 判断是否处在自己设定的环境当中，假如是就返回true ,否则就返回false boolean flag = environment.acceptsProfiles(profiles); return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .enable(flag) //enable : 是否启动Swagger ,如果为false那么就不启动 否则就启动 .groupName("吉士先生") //groupName 进行分组的操作 .select() .apis(RequestHandlerSelectors.basePackage("com.jsxs.controller")) // .paths(PathSelectors.ant("/jsxs/**")) .build(); }
2、如何配置多个分组？配置多个分组只需要配置多个docket即可：
@Bean public Docket docket1(){ return new Docket(DocumentationType.SWAGGER_2).groupName("A"); } @Bean public Docket docket2(){ return new Docket(DocumentationType.SWAGGER_2).groupName("B"); } @Bean public Docket docket3(){ return new Docket(DocumentationType.SWAGGER_2).groupName("C"); }
7.实体配置
1、新建一个实体类
这里如果设置成私有属性，那么我们必须要添加get 和 set 方法才能被扫描到。也可以直接使用public进行实现
package com.jsxs.pojo; public class User { // 设置成私有属性是扫描不到的，只有公有属性才能访问到. 如果非要写成私有属性的话，那么我们就需要get 和 set 方法 public String username; public String password; }
2、只要这个实体在请求接口的返回值上（即使是泛型），都能映射到实体项中：
@PostMapping("/user") // 只要我们的接口中，返回值存在实体类，他就会被扫描到Swagger中 public User test2(){ return new User(); }
3、重启查看测试
4、为Swagger的实体类添加注释
并不是因为@ApiModel这个注解让实体显示在这里了，而是只要出现在接口方法的返回值上的实体都会显示在这里，而@ApiModel和@ApiModelProperty这两个注解只是为实体添加注释的。
@ApiModel为类添加注释
@ApiModelProperty为类属性添加注释
package com.jsxs.pojo; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; @ApiModel("用户实体类") // 这里的作用就是: 我们在Swagger中显示的都是英文，这个注解就是让Swagger的英文改变成你想要的语言 -----》 类 public class User { // 设置成私有属性是扫描不到的，只有公有属性才能访问到. 如果非要写成私有属性的话，那么我们就需要get 和 set 方法 @ApiModelProperty("用户名") public String username; @ApiModelProperty("密码") public String password; }
8.常用注解
Swagger的所有注解定义在io.swagger.annotations包下
下面列一些经常用到的，未列举出来的可以另行查阅说明：
类 方法 参数
package com.jsxs.controller; import com.jsxs.pojo.User; import io.swagger.annotations.Api; import io.swagger.annotations.ApiOperation; import io.swagger.annotations.ApiParam; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RestController; @Api(tags = "HelloController -> 控制类 ") // 类 @RestController public class HelloController { @ApiOperation("/hello -> 控制类方法接口") // 方法 @GetMapping("/hello") public String test(){ return "测试成功"; } @ApiOperation("/user -> 控制类方法接口") @PostMapping("/user") // 只要我们的接口中，返回值存在实体类，他就会被扫描到Swagger中 public User test2(){ return new User(); } @ApiOperation("/user2 -> 控制类方法接口") @PostMapping("/user2") public User test3(@ApiParam("参数-》用户名") String username){ // 参数 return new User(); } }
这样的话，可以给一些比较难理解的属性或者接口，增加一些配置信息，让人更容易阅读！
相较于传统的Postman或Curl方式测试接口，使用swagger简直就是傻瓜式操作，不需要额外说明文档(写得好本身就是文档)而且更不容易出错，只需要录入数据然后点击Execute，如果再配合自动化框架，可以说基本就不需要人为操作了。
Swagger是个优秀的工具，现在国内已经有很多的中小型互联网公司都在使用它，相较于传统的要先出Word接口文档再测试的方式，显然这样也更符合现在的快速迭代开发行情。当然了，提醒下大家在正式环境要记得关闭Swagger，一来出于安全考虑,二来也可以节省运行时内存。
9.进行测试请求状态
@ApiOperation("/user -> 控制类方法接口") @PostMapping("/user") // 只要我们的接口中，返回值存在实体类，他就会被扫描到Swagger中 public User test2(){ return new User(); } @ApiOperation("/user2 -> 控制类方法接口") @PostMapping("/user2") public User test3(@ApiParam("参数-》用户对象") User user){ // 参数 int i=5/0;
我们故意设置一个500的错误，在这里我们进行Excute的时候，发现会出现一个500错误
看/ user 的请求找到try out
