SpringBoot整合springFox

1 springFox 介绍

springFox算是swagger优化。它可以跟据业务代码自动生成相关的api接口文档，尤其用于restful风格中的项目，开发人员几乎可以不用专门去维护rest api，这个框架可以自动为你的业务代码生成restfut风格的api，而且还提供相应的测试界面，自动显示json格式的响应。大大方便了后台开发人员与前端的沟通与联调成本。

springfox本身只是利用自身的aop的特点，通过plug的方式把swagger集成了进来，它本身对业务api的生成，还是依靠swagger来实现

主要的好处：

1前后端分离开发

2API文档非常明确

3测试的时候不需要再使用URL输入浏览器的方式来访问Controller

4传统的输入URL的测试方式对于post请求的传参比较麻烦

5springfox基于swagger2，兼容老版本

6可以减少开发人员的文档编写时间及统一管理

7其他强大的功能

2springboot 整合 springFox

1首先创建一个 springboot工程

2 首先在pom文件里加入依赖

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger2</artifactId>

</dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger-ui</artifactId>

</dependency>

加入之后整个pom文件

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-parent</artifactId>

<version>2.1.5.RELEASE</version>

</parent>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-web</artifactId>

</dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger2</artifactId>

</dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger-ui</artifactId>

</dependency>

</dependencies>

注意：加入依赖之后如果报错请进行maven clear maven install

之后我们自己写一个config类上面加上两个注解@EnableSwagger2

@Configuration 如下图

最后我们自己写一个 controller

@Api(tags="测试类")

@RestController

public class DemoController {

@ApiOperation("测试方法")

@GetMapping("hello")

public String hello() {

return "success";

}

3 访问页面

我们可以看到在我们加入 springFox 依赖之后，我们项目的依赖管理里面出现了springfox-swagger-ui-2.6.1.jar，我们点进去，在里面的 resource中有一个html文件

这就是我们springfox 与swagger整合的进入页面

访问页面地址http://localhost:8080/swagger-ui.html

我们发现发圈的地方和我们这两个注解写的内容一样

@Api(tags="测试类") 用来注释类的错用

@ApiOperation("测试方法") 用来注释方法的作用

接下来我们在demoController的方法中加入参数和注解点击try it out

@Api(tags="测试类")

@RestController

public class DemoController {

@ApiImplicitParams({

@ApiImplicitParam(name="username",value="用户名"),

@ApiImplicitParam(name="password",value="密码")

})

@ApiOperation("测试方法")

@GetMapping("hello")

public String hello(String username,Stringpassword) {

return "username="+username+"\tpassword="+password;

}

我们会发现参数的username 和password 通过@ApiImplicitParams 注解也给加上了注释接下来我们点击try it out 看下图点击输入参数后点击Execute

在 @ApiImplicitParam(name="username",value="用户名"),后面还可以上上其他注解如下图

可以自己点进去具体查看

接下来我们创建一个 user类并且在上面加上注解

@ApiModel

public class User {

@ApiModelProperty("用户名")

private String username;

@ApiModelProperty("密码")

private String password;

public String getUsername() {

return username;

}

public void setUsername(String username) {

this.username = username;

}

public String getPassword() {

return password;

}

public void setPassword(String password) {

this.password = password;

}

我们可以看到效果如下图

会出现一个Models 我们点进去

我们会发现在bean类的属性家的注释也显示了，方便前后台对接，好了今天我们先说到这里