springboot框架下集成接口测试框架swagger2

最新推荐文章于 2024-09-13 22:23:10 发布

逐梦s

最新推荐文章于 2024-09-13 22:23:10 发布

阅读量283

点赞数 1

分类专栏： java

sdream

本文链接：https://blog.csdn.net/qq_28449663/article/details/106858948

版权

java 专栏收录该内容

8 篇文章 0 订阅

订阅专栏

本文介绍了如何在SpringBoot项目中集成Swagger2，包括引入依赖、配置 Swagger2、解决访问路径问题、在启动类中启用 Swagger2，以及如何为Controller和参数添加注释，以便进行接口测试。

摘要由CSDN通过智能技术生成

1.引入jar包

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

2.添加swagger2配置信息

import com.google.common.base.Predicates;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @description: swagger2配置
 * @author: ltl
 **/
@Configuration
@EnableSwagger2
public class Swagger2Config {


        @Bean
        public Docket webApiConfig(){
            return new Docket(DocumentationType.SWAGGER_2)
                    .groupName("webApi")
                    .apiInfo(webApiInfo())
                    .select()
                    .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                    .paths(Predicates.not(PathSelectors.regex("/error.*")))
                    .build();
        }

        private ApiInfo webApiInfo(){
            return new ApiInfoBuilder()
                    .title("测试API文档")
                    .description("测试API接口定义")
                    .version("1.0")
                    .contact(new Contact("ltl", "www.baidu.com", "1250197291@qq.com"))
                    .build();
        }
}

3.解决swagger路径无法访问

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;

import javax.annotation.Resource;

/**
 * @author ltl
 */
@Configuration
public class MyPatternConfiguration extends WebMvcConfigurationSupport {

    @Resource
    private ConfigProperties configProperties;

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        String os = System.getProperty("os.name");
        String WINDOWS = "win";

        registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");
        registry.addResourceHandler("/public/**").addResourceLocations("classpath:/public/");

        // 解决swagger无法访问
        registry.addResourceHandler("/swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
        // 解决swagger的js文件无法访问
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");

        if(os.toLowerCase().startsWith(WINDOWS)){
           
            
        } else{
            
            
        }
        super.addResourceHandlers(registry);
    }

}

4.在启动类上加上swagger2注解

@EnableSwagger2

5.编写相应的controller

ApiImplicitParams添加参数注释

@RestController
@Slf4j
@RequestMapping("/user")
@Api(tags = "用户服务API")
public class UserRestController {

    /**
     * 用户验证
     * @param user 用户信息
     * @return 验证结果
     */
    @PostMapping("/post/login")
    @ResponseBody
    @ApiOperation(value = "用户验证")
    @ApiImplicitParams({
            @ApiImplicitParam(name="suUserId",value = "用户名",required=true,paramType="form"),
            @ApiImplicitParam(name="suPwd",value = "用户密码",required=true,paramType="form")
    })
    public String login(User user) {
        return "登录成功";
    }
}

在实体类中添加参数注释

//控制层
@RestController
@Slf4j
@RequestMapping("/user")
@Api(tags = "用户服务API")
public class UserRestController {

    /**
     * 用户验证
     * @param user 用户信息
     * @return 验证结果
     */
    @PostMapping("/post/login")
    @ResponseBody
    @ApiOperation(value = "用户验证")
    public String login(User user) {
        return "登录成功";
    }
}

//实体类
@Data
@AllArgsConstructor
@NoArgsConstructor
@ApiModel
public class User {

    /**
     * 主键id
     */
    @ApiModelProperty(value = "id",name = "id",hidden = true)
    private Long id;

    /**
     * 用户id
     */
    @ApiModelProperty(value = "用户名",name = "suUserId",required = true,example = "admin")
    private String suUserId;
    /**
     * 用户密码
     */
    @ApiModelProperty(value = "密码",name = "suPwd",required = true,example = "Yyt123")
    private String suPwd;
}

3.使用ApiParam添加参数注释

@RestController
@Slf4j
@RequestMapping("/user")
@Api(tags = "用户服务API")
public class UserRestController {

    /**
     * 用户验证
     * @param user 用户信息
     * @return 验证结果
     */
    @PostMapping("/post/login")
    @ResponseBody
    @ApiOperation(value = "用户验证")
    public String login(@ApiParam(name="username", value = "用户名", required = true) String username,@ApiParam(name="password", value = "密码", required = true) String password) {
        return "登录成功";
    }
}