java swagger后端接口测试

71 阅读 0 评论 47 点赞

我是靠谱客的博主失眠麦片，最近开发中收集的这篇文章主要介绍java swagger后端接口测试，觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

在写项目的时候接口的请求方式有各种，get，post，delete，put.
get请求还好测试，直接在浏览器输入url就可，但对于post，等其他方式的请求，单独浏览器就显得乏力了。
测试接口的工具很多，postman，postwoman就是不错的选择，但感觉打开应用还是有点麻烦和慢，还是喜欢直接浏览器测试接口，所以我推荐swagger.
先官方的介绍一下swagger:

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法、参数和模型紧密集成到服务器端的代码，允许 API 来始终保持同步。Swagger 让部署管理和使用功能强大的 API 从未如此简单。
官网地址：https://swagger.io/
百度搜索swagger也能找到相应的一些配置.
这边我就把我的swagger配置展示出来(ps: 也是在看视频项目中跟随视频的)

首先是pom依赖
pom.xml

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

java代码：

SwaggerConfig.java

package com.sixteen.servicebase;

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;

@Configuration
@EnableSwagger2
public class SwaggerConfig {//swagger配置
    @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("本文档描述了课程中心微服务接口定义")
                .version("1.0")
                .contact(new Contact("java", "http://xxx.com", "1123@qq.com"))
                .build();
    }
}

另外加一份mybatis-plus代码生成器，在代码生成器中把swagger开启,
配置中的gc.setSwagger2(true);记得开启
CodeGenerator.java

package com.sixteen;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import org.junit.Test;

public class CodeGenerator {
    @Test
    public void run() {

        // 1、创建代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 2、全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");//建议使用绝对路径
        gc.setOutputDir("写自己的项目路径，使用绝对路径" + "/src/main/java");
        gc.setAuthor("sixteen");//设置作者

        gc.setOpen(false); //生成后是否打开资源管理器
        gc.setFileOverride(false); //重新生成时文件是否覆盖

        //UserService，不加就是IUserService
        gc.setServiceName("%sService");	//去掉Service接口的首字母I
        gc.setIdType(IdType.ID_WORKER_STR); //主键策略，如果是long类型就算ID_WORKER，string类型就ID_WORKER_STR，可以自行查找主键策略进行配置

        gc.setDateType(DateType.ONLY_DATE);//定义生成的实体类中日期类型
        gc.setSwagger2(true);//开启Swagger2模式

        mpg.setGlobalConfig(gc);

        // 3、数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/test?serverTimezone=Asia/Shanghai&useSSL=true&useUnicode=true&characterEncoding=UTF-8");//mysql8.0版本以上需要配置后面的参数，至少配置serverTimezone=Asia/Shanghai
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");//mysql8.0版本以上导入的驱动包
        dsc.setUsername("root");//mysql用户名
        dsc.setPassword("123456");//mysql密码
        dsc.setDbType(DbType.MYSQL);//数据库类型
        mpg.setDataSource(dsc);

        // 4、包配置
        PackageConfig pc = new PackageConfig();

        //下面两个设置最后会生成：com.sixteen.eduservice
        pc.setModuleName("educenter"); //模块名
        pc.setParent("com.sixteen");

        //设置controller，dao，entity，service层，可以改名字
        pc.setController("controller");
        pc.setEntity("entity");
        pc.setService("service");
        pc.setMapper("mapper");
        mpg.setPackageInfo(pc);

        // 5、策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setInclude("ucenter_member");//数据库表名，可以多个，多个strategy.setInclude("table1","table2")

        strategy.setNaming(NamingStrategy.underline_to_camel);//数据库表映射到实体的命名策略
        strategy.setTablePrefix(pc.getModuleName() + "_"); //生成实体时去掉表前缀

        strategy.setColumnNaming(NamingStrategy.underline_to_camel);//数据库表字段映射到实体的命名策略
        strategy.setEntityLombokModel(true); // lombok 模型 @Accessors(chain = true) setter链式操作

        strategy.setRestControllerStyle(true); //restful api风格控制器
        strategy.setControllerMappingHyphenStyle(true); //url中驼峰转连字符

        mpg.setStrategy(strategy);


        // 6、执行
        mpg.execute();
    }
}