通达信交易接口qq-springboot集成Swagger从零开始实现

Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger让部署管理和使用功能强大的API变得非常简单。

Swagger要解决的问题

前后端分离：

前端->前端控制层、视层后端->后端控制层、服务层、数据访问层前后端通过API进行交互前后端相对独立且松耦合

产生的问题

前后端集成，前端或者后端无法做到“及时协商，尽早解决”，最终导致问题集中爆发。

解决方案-Swagger

SpringBoot集成Swagger详细步骤

新建一个SpringBoot-web项目

之后选定springInitializr，指定默认的java版本，随后编辑自己的项目名等一路next

随后添加Maven依赖

编写Controller，测试确保springboot项目可以运行成功！

注意这里为了返回json类型的结果需要使用@RestController注解

运行成功

集成Swagger，我们需要编写一个配置类-SwaggerConfig来配置Swagger

配置Swagger

Swagger实例Bean是Docket，所以通过配置Docket实例来配置Swaggger。

@Bean //配置docket以配置Swagger具体参数
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2);
}

可以通过apiInfo属性配置文档信息

Docket实例关联上apiInfo

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
}

Swagger配置类整体代码如下：

配置扫描接口

构建Docket时通过select方法配置怎么扫描接口。

//配置了Swagger的Docket的bean实例
@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置扫描接口的方式
      .apis(RequestHandlerSelectors.basePackage("com.zhao.swagger.controller"))//basePackage：指定要扫描的包
      .build();
}

重启项目测试，由于我们配置根据包的路径扫描接口，所以我们只能看到一个类

除了通过包路径配置扫描接口外，还可以通过配置其他方式扫描接口，这里注释一下所有的配置方式：

any() // 扫描所有，项目中的所有接口都会被扫描到
none() // 不扫描接口
// 通过方法上的注解扫描，如withMethodAnnotation(GetMapping.class)只扫描get请求
withMethodAnnotation(final Class<? extends Annotation> annotation)
// 通过类上的注解扫描，如.withClassAnnotation(Controller.class)只扫描有controller注解的类中的接口
withClassAnnotation(final Class<? extends Annotation> annotation)
basePackage(final String basePackage) // 根据包路径扫描接口

除此之外，我们还可以配置接口扫描过滤：

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.zhao.swagger.controller"))
       // 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口
      .paths(PathSelectors.ant("/zhao/**"))
      .build();
}

这里的可选值还有

any() // 任何请求都扫描
none() // 任何请求都不扫描
regex(final String pathRegex) // 通过正则表达式控制
ant(final String antPattern) // 通过ant()控制

配置Swagger开关

通过enable方法配置是否启用swagger，如果是false，swagger将不能在浏览器中访问了

 @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(false)
                .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口


                .apis(RequestHandlerSelectors.basePackage("com.zhao.swagger.controller"))
                //配置扫描接口过滤
                // 配置如何通过path过滤,即这里只扫描请求以/zhao开头的接口
                .paths(PathSelectors.ant("/zhao/**"))
                .build();
    }

判断是不是生产环境flag=false

注入enable

多环境配置：

创建生产环境和测试环境的配置文件：

生产环境dev端口号设置为8081，测试环境pro端口号设置为8082

@Bean
    public Docket docket(Environment environment) {
        // 设置要显示swagger的环境
        Profiles of = Profiles.of("dev", "test");//test环境不存在也可以写
        // 判断当前是否处于该环境
        // 通过 enable() 接收此参数判断是否要显示
        boolean b = environment.acceptsProfiles(of);

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(b)//配置是否启用Swagger，如果是false，在浏览器将无法访问
                .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口


                .apis(RequestHandlerSelectors.basePackage("com.zhao.swagger.controller"))
                //配置扫描接口过滤
                // 配置如何通过path过滤,即这里只扫描请求以/zhao开头的接口
                .paths(PathSelectors.ant("/zhao/**"))
                .build();
    }

这里我们先不指定dev或者pro，而是不做任何改动的使用默认环境8080来做测试

看效果默认Swagger是关闭的

现在我们不需要该代码而是直接修改配置文件更改环境

运行再看一下效果运行成功！

下面把环境切换到pro，并没有在config中配置该环境

端口改成8082运行看一下效果;无法启动Swagger

至此SwggerConfig配置类的全部代码为

配置API分组

如果没有配置分组，默认是default。通过groupName方法即可配置分组：

@Bean
    public Docket docket(Environment environment) {
        // 设置要显示swagger的环境
        Profiles of = Profiles.of("dev", "test");//test环境不存在也可以写
        // 判断当前是否处于该环境
        // 通过 enable() 接收此参数判断是否要显示
        boolean b = environment.acceptsProfiles(of);

        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("docket1")
                .apiInfo(apiInfo())
                .enable(b)//配置是否启用Swagger，如果是false，在浏览器将无法访问
                .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口


                .apis(RequestHandlerSelectors.basePackage("com.zhao.swagger.controller"))
                //配置扫描接口过滤
                // 配置如何通过path过滤,即这里只扫描请求以/zhao开头的接口
                .paths(PathSelectors.ant("/zhao/**"))
                .build();
    }

配置多个分组只需要配置多个docket即可：

 @Bean
    public Docket docket1(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("group1");
    }
    @Bean
    public Docket docket2(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("group2");
    }
    @Bean
    public Docket docket3(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("group3");
    }

重启项目查看，这里我们默认的是docket1接口；

实体类配置

新建一个实体类

public class User {
    public String name;
    public String password;
}

在controller中添加方法，只要这个实体在请求接口的返回值上，都能映射到实体项中：

  @RequestMapping("/getUser")
    public User getUser(){
        return new User();
    }
}

重启查看测试

添加注解：

注：并不是因为@ApiModel这个注解让实体显示在这里了，而是只要出现在接口方法的返回值上的实体都会显示在这里，而@ApiModel和@ApiModelProperty这两个注解只是为实体添加注释的。

@ApiModel为类添加注释

@ApiModelProperty为类属性添加注释

@ApiModel("用户实体类")

public class User {
    @ApiModelProperty("用户名")
    public String name;
    @ApiModelProperty("密码")
    public String password;
}

只要这个实体在请求接口的返回值上，都能映射到实体项中：

@RequestMapping("/getUser")
public User getUser(){
   return new User();
}

其他测试

 @ApiOperation("hello控制类")
    @GetMapping(value = "/hello2")
    public String hello2(@ApiParam("用户名") String username){
        return "hello"+username;
    }
    @ApiOperation("post测试类")
    @PostMapping(value = "/postt")
    public User postt(@ApiParam("用户名") User user){
        int i=5/0;
        return user;
    }

之后我们可以在指定接口内进行测试

其他皮肤

我们可以导入不同的包实现不同的皮肤定义：

<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.9.2</version>
</dependency>

<!-- 引入swagger-bootstrap-ui包 /doc.html-->
<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.9.1</version>
</dependency>

总结：

我们可以通过Swagger给一些比较困难理解的属性或者接口增加注释信息

接口文档可以实时更新

可以在线测试

相较于传统的Postman或Curl方式测试接口，使用swagger操作简单便捷，不需要额外说明文档而且更不容易出错，只需要录入数据然后点击Execute，如果再配合自动化框架，可以说基本就不需要人为操作了。

Swagger是个优秀的工具，现在国内已经有很多的中小型互联网公司都在使用它，相较于传统的要先出Word接口文档再测试的方式，显然这样也更符合现在的快速迭代开发行情。当然了，提醒下大家在正式环境要记得关闭Swagger，一来出于安全考虑二来也可以节省运行时内存。

文章为作者独立观点，不代表股票程序化软件自动交易接口观点

通达信交易接口qq-为什么阿里巴巴Java开发手册中强制要求接口返回值不允许使