通达信接口自动下单:自动生成API文档 Swagger

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

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

重启查看测试

前后端相对独立且松耦合

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

@Bean
public Docket docket(Environment environment) {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
.groupName("hello") // 配置分组
// 省略配置....
}

@ApiModel为类添加注释

解决方案

前后端通过API进行交互

如何配置多个分组？配置多个分组只需要配置多个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");
}

后端->后端控制层、服务层、数据访问层

常用注解

Swagger的所有注解定义在io.swagger.annotations包下

@ApiOperation("狂神的接口")
@PostMapping("/kuang")
@ResponseBody
public String kuang(@ApiParam("这个名字会被返回")String username){
return username;
}

使用Swagger

配置Swagger开关

SpringBoot集成Swagger=>springfox，两个jar包

直接运行，在线测试API

配置API分组

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

编写HelloController，测试确保运行成功！

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

添加Maven依赖

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

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

前端->前端控制层、视层

这里的可选值还有：

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

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

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

@Bean
public Docket docket() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.enable(false) //配置是否启用Swagger，如果是false，在浏览器将无法访问
.select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
.apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
// 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口
.paths(PathSelectors.ant("/kuang/**"))
.build();
}

首先定义schema[计划的提纲]，并实时跟踪最新的API，降低集成风险

Docket实例关联上apiInfo


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

了解Swagger的概念及作用

新建一个实体类


@ApiModel("用户实体")
public class User {
@ApiModelProperty("用户名")
public String username;
@ApiModelProperty("密码")
public String password;
}

配置扫描接口

号称世界上最流行的API框架

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


@Bean
public Docket docket() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
.apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
.build();
}

如何动态配置当项目处于test、dev环境时显示swagger，处于prod时不显示？

@Bean
public Docket docket(Environment environment) {
// 设置要显示swagger的环境
Profiles of = Profiles.of("dev", "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.kuang.swagger.controller"))
// 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口
.paths(PathSelectors.ant("/kuang/**"))
.build();
}

实体配置

掌握在项目中集成Swagger自动生成API文档

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

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) // 根据包路径扫描接口

重启项目查看即可

重启项目查看分组

@ApiModelProperty为类属性添加注释

拓展：其他皮肤

RestfulApi文档在线自动生成器=>API文档与API定义同步更新

支持多种语言

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

@Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {
}

产生的问题

配置Swagger

前后端分离

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

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

新建一个SpringBoot-web项目

要求：jdk8+否则swagger2无法运行spring.mvc.pathmatch.matching-strategy=ant_path_matcherspringboot6以上需要加入这个配置

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

步骤：

自动生成API文档 Swagger

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

这样的话，可以给一些比较难理解的属性或者接口，增加一些配置信息，让人更容易阅读！

文章为作者独立观点，不代表股票交易接口观点