SpringBoot整合springFox

╰半橙微兮° 2022-12-20 01:57 217阅读 0赞

# **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工程** ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Noa3N0YXJ0_size_16_color_FFFFFF_t_70][]

### **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 如下图

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Noa3N0YXJ0_size_16_color_FFFFFF_t_70 1][]

最后 我们自己写一个 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文件

![2020110914362728.png][]

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

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Noa3N0YXJ0_size_16_color_FFFFFF_t_70 2][]

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

@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;

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Noa3N0YXJ0_size_16_color_FFFFFF_t_70 3][]

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Noa3N0YXJ0_size_16_color_FFFFFF_t_70 4][]

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Noa3N0YXJ0_size_16_color_FFFFFF_t_70 5][]

可以自己点进去 具体查看

接下来 我们 创建一个 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;

我们 可以看到效果如下图

![20201109143726328.png][]

会出现 一个Models 我们点进去

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Noa3N0YXJ0_size_16_color_FFFFFF_t_70 6][]

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

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Noa3N0YXJ0_size_16_color_FFFFFF_t_70]: /images/20221120/e3eedeccf864470798e33eb2904ae200.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Noa3N0YXJ0_size_16_color_FFFFFF_t_70 1]: /images/20221120/a9dad009fc0848a4b5fc1082bdefc2d0.png
[2020110914362728.png]: https://img-blog.csdnimg.cn/2020110914362728.png
[http_localhost_8080_swagger-ui.html]: http://localhost:8080/swagger-ui.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Noa3N0YXJ0_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/2020110914363667.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Noa3N0YXJ0,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Noa3N0YXJ0_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20201109143646983.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Noa3N0YXJ0,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Noa3N0YXJ0_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20201109143654140.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Noa3N0YXJ0,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Noa3N0YXJ0_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20201109143703681.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Noa3N0YXJ0,size_16,color_FFFFFF,t_70
[20201109143726328.png]: https://img-blog.csdnimg.cn/20201109143726328.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Noa3N0YXJ0_size_16_color_FFFFFF_t_70 6]: https://img-blog.csdnimg.cn/20201109143732281.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Noa3N0YXJ0,size_16,color_FFFFFF,t_70