项目整合Swagger2测试工具

Taurus_3

已于 2022-08-04 09:50:03 修改

阅读量115

点赞数

文章标签： java spring intellij-idea

于 2022-06-14 16:43:39 首次发布

本文链接：https://blog.csdn.net/qq_61378705/article/details/125280744

版权

什么是swagger2

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

第一步引入依赖

在pom.xml文件中引入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>

第二步配置swagger工具类

根据自己项目的实际开发需求修改路径信息等

@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket webApiConfig(){

        return new Docket(DocumentationType.SWAGGER_2)
                //分组名字（根据自己的实际项目修改，下同）
                .groupName("webApi")
                //webapi的信息（根据自己的实际项目修改，下同）
                .apiInfo(webApiInfo())
                .select()
                //只显示api路径下的页面（根据自己的实际路径修改，下同）
                .paths(Predicates.and(PathSelectors.regex("/api/.*")))
                .build();

    }

    @Bean
    public 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("xzy", "http://xzy.com", "493211102@qq.com"))
                .build();
    }

    private ApiInfo adminApiInfo(){

        return new ApiInfoBuilder()
                .title("后台管理系统-API文档")
                .description("本文档描述了后台管理系统微服务接口定义")
                .version("1.0")
                .contact(new Contact("xzy", "http://xzy.com", "49321112@qq.com"))
                .build();
    }

}

第三步登录Swagger2网站

注意8080端口根据自己实际项目更改

http://localhost:8080/swagger-ui.html

第四步接口使用演示

常用注解

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

    @Api：修饰整个类，描述Controller的作用

    @ApiOperation：描述一个类的一个方法，或者说一个接口

    @ApiParam：单个参数描述

    @ApiModel：用对象来接收参数

    @ApiModelProperty：用对象接收参数时，描述对象的一个字段

    @ApiImplicitParam：一个请求参数

@ApiImplicitParams：多个请求参数