写点什么

软件测试学习笔记丨 Spring Boot 结合 Swagger 生成 API

作者:测试人
  • 2024-05-11
    北京
  • 本文字数:3523 字

    阅读完需:约 12 分钟

本文转自测试人社区,原文链接:https://ceshiren.com/t/topic/30445

一, Swagger 作用

  1. 前后端分离开发更加方便,有利于团队协作

  2. 接口文档在线自动生成,降低后端开发编写接口文档负担

  3. 功能测试

二, 导入依赖

<dependency>      <groupId>io.springfox</groupId>      <artifactId>springfox-boot-starter</artifactId>      <version>3.0.0</version>  </dependency>
复制代码

三, 解决启动问题,新建 SwaggerConfiguration 类

package com.ceshiren.springtest.config;
import org.springframework.beans.BeansException;import org.springframework.beans.factory.config.BeanPostProcessor;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.util.ReflectionUtils;import org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping;import springfox.documentation.spring.web.plugins.WebFluxRequestHandlerProvider;import springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider;import java.lang.reflect.Field;import java.util.List;import java.util.stream.Collectors;
@Configuration//@EnableSwagger2 //开启swagger注解支持 有了这个注解,就可以去整体的项目下/controller包下扫描其他的swagger注解public class SwaggerConfiguration { @Bean public static BeanPostProcessor springfoxHandlerProviderBeanPostProcessor() { return new BeanPostProcessor() {
@Override public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException { if (bean instanceof WebMvcRequestHandlerProvider || bean instanceof WebFluxRequestHandlerProvider) { customizeSpringfoxHandlerMappings(getHandlerMappings(bean)); } return bean; }
private <T extends RequestMappingInfoHandlerMapping> void customizeSpringfoxHandlerMappings(List<T> mappings) { List<T> copy = mappings.stream() .filter(mapping -> mapping.getPatternParser() == null) .collect(Collectors.toList()); mappings.clear(); mappings.addAll(copy); }
@SuppressWarnings("unchecked") private List<RequestMappingInfoHandlerMapping> getHandlerMappings(Object bean) { try { Field field = ReflectionUtils.findField(bean.getClass(), "handlerMappings"); field.setAccessible(true); return (List<RequestMappingInfoHandlerMapping>) field.get(bean); } catch (IllegalArgumentException | IllegalAccessException e) { throw new IllegalStateException(e); } } }; }}
复制代码

四, 配置文件配置

spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER
复制代码

五, 访问:http://localhost:8080/swagger-ui/


六, 自定义配置信息

6.1 在 SwaggerConfiguration 类添加配置信息

private ApiInfo apiInfo() {        return new ApiInfoBuilder()                // 页面标题                .title("spring-test系统")                // 描述                .description("spring-test-lp 接口文档")                // 创建人信息                .contact(new Contact("demi", "", "liupan0721@gmail.com"))                // 项目API版本号                .version("1.0.0")                .build();    }

@Bean public Docket docket() { //Swagger 的配置主要围绕Docket bean 进行: return new Docket(DocumentationType.OAS_30) //配置是否启用Swagger,如果是false,在浏览器将无法访问,默认是true .enable(true) .groupName("spring-test interface") .apiInfo(apiInfo())// .globalRequestParameters(globalRequestParameters())//在定义Docket bean 之后,它的select()方法返回一个ApiSelectorBuilder的实例,它提供了一种控制 Swagger 暴露的端点的方法 .select() //any - 任何请求都扫描 ; none - 任何请求都不扫描 ; basePackage - 扫描指定对应的包名下的controller// .apis(RequestHandlerSelectors.any()) .apis(RequestHandlerSelectors.basePackage("com.ceshiren.springtest")) .paths(PathSelectors.any()).build();//我们可以在RequestHandlerSelectors和PathSelectors的帮助下配置用于选择RequestHandler的谓词。对两者都使用any()将使我们的整个 API 的文档可以通过 Swagger 获得。 }
//生成全局通用参数 private List<RequestParameter> globalRequestParameters() { List<RequestParameter> parameters = new ArrayList<>();
// 公共请求参数生成器-token RequestParameter tokenParameter = new RequestParameterBuilder() .in(ParameterType.HEADER)//在swagger里显示header .name("token")//header的参数名为 token .description("对应的token值")
.required(true)//对应参数是否为必传,如果不是必传参数则设置为false .query(param -> param.model(model -> model.scalarModel(ScalarType.STRING)))
.build(); //为消费者提供帮助建立模型 更新标量类型 // 公共请求参数生成器-udid RequestParameter udidParameter = new RequestParameterBuilder() .in(ParameterType.QUERY)//在swagger里显示header .name("udid")//header的参数名为 token .description("设备的ID") .required(false)//对应参数是否为必传,如果不是必传参数则设置为false .query(param -> param.model(model -> model.scalarModel(ScalarType.STRING))) .build();
parameters.add(tokenParameter); parameters.add(udidParameter); return parameters;// Collections.singletonList(parameterBuilder.build()); }
复制代码

6.2 启动服务验证修改成功


6.3 Swagger 四部分布局

  • API 分组:如果没有配置分组默认是 default

  • 基本描述:Swagger 实例 Docket 的 apiInfo()方法中的 ApiInfo 实例参数配置文档信息

  • 请求接口列表:只要被 Swagger 扫描匹配到的请求都会出现

  • 实体列表

6.4 Swagger 常用注解


6.4.1 对应类和方法上的注解

@RestController@Api(tags = "POST请求")public class PostController {
@ApiOperation("register接口") @PostMapping(path = "/{module}/register", produces = "application/json") @ApiImplicitParams({ @ApiImplicitParam(name="module", value="模块名称"), @ApiImplicitParam(name="desc", value="描述"), @ApiImplicitParam(name="age", value="年龄") }) String registerAndParam(@RequestBody UserDto userDto, @PathVariable String module, @RequestParam String desc, @RequestParam int age){
return "用户登录成功!用户名:" + userDto.getUsername() + ", 密码:" +userDto.getPassword() + ", 模块:"+ module + ", 描述:" +desc + ", 年龄:" +age; } }
复制代码

6.4.2 Swagger 页面展示


6.4.3 实体类及属性上使用的注解实例

@Data@ApiModel(value = "用户实体类",description = "请求参数的用户实体类")public class UserDto {    @ApiModelProperty(value = "用户名称", example = "demi", required = true)    String username;    @ApiModelProperty(value = "用户密码", example = "123456", required = true)    String password;
}
复制代码

6.4.4 Swagger 页面展示


软件测试开发免费视频教程分享


发布于: 刚刚阅读数: 5
用户头像

测试人

关注

专注于软件测试开发 2022-08-29 加入

霍格沃兹测试开发学社,测试人社区:https://ceshiren.com/t/topic/22284

评论

发布
暂无评论
软件测试学习笔记丨Spring Boot结合 Swagger 生成 API_软件测试_测试人_InfoQ写作社区