Swagger接口文档管理工具

Swagger

1、Swagger
- 1.1 swagger介绍
- 1.2 项目集成swagger流程
- 1.3 项目集成swagger
2、knife4j
- 2.1 knife4j介绍
- 2.2 项目集成knife4j

1、Swagger

1.1 swagger介绍

官网：https://swagger.io/

在这里插入图片描述

Swagger 是一个规范和完整的Web API框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

功能主要包含以下几点:

A. 使得前后端分离开发更加方便，有利于团队协作;

B. 接口文档在线自动生成，降低后端开发人员编写接口文档的负担;

C. 接口功能测试;

使用Swagger只需要按照它的规范去定义接口及接口相关的信息，再通过Swagger衍生出来的一系列项目和工具，就可以做到生成各种格式的接口文档，以及在线接口调试页面等等;

1.2 项目集成swagger流程

引入swagger依赖；
定义swagger配置类；
- swagger扫描管理的web资源路径；
- 配置项目文档标题、描述、版本等信息、官网地址等信息；
通过swagger注解给指定资源添加描述信息；
项目启动，访问并测试在线资源；

1.3 项目集成swagger

在 MAVEN构建的项目中引入依赖
pom.xml

<!--引入swagger依赖-->
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
</dependency>
<!--swagger ui支持-->
<!--        导错3.0.0的包导致swagger-ui.html界面显示不出来-->
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger-ui</artifactId>
</dependency>

在项目工程config包定义swagger配置类

 package com.shen.stock.config;


 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.builders.RequestHandlerSelectors;
 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;
 /**
  * 定义swagger配置类
  */
 @Configuration
 @EnableSwagger2
 public class SwaggerConfiguration {
    @Bean
    public Docket buildDocket() {
       //构建在线API概要对象
       return new Docket(DocumentationType.SWAGGER_2)
               .select()
               // 要扫描的API(Controller)基础包
               .apis(RequestHandlerSelectors.basePackage("com.shen.stock.controller"))
               .paths(PathSelectors.any())
               .build()
               .apiInfo(buildApiInfo())
               .enable(true);
    }
    private ApiInfo buildApiInfo() {
       //网站联系方式
       Contact contact = new Contact("假设在百度","https://www.baidu.com","bhd42414666@163.com");
       return new ApiInfoBuilder()
               .title("今日指数-在线接口API文档")//文档标题
               .description("这是一个方便前后端开发人员快速了解开发接口需求的在线接口API文档")//文档描述信息
               //.contact(contact)//站点联系人相关信息
               .version("1.0.0")//文档版本
               .build();
    }
 }

在stock_backend工程导入配置类：

  @SpringBootApplication
  @MapperScan("com.shen.stock.mapper") //扫描持久层的接口统一生成代理对象，并维护到spring的IOC容器中
  public class BackendApp {
      public static void main(String[] args) {
          SpringApplication.run(BackendApp.class, args);
      }
  }

swagger相关注解介绍

注解	位置	说明
@Api	类	加载Controller类上,表示对类的说明
@ApiModel	类(通常是实体类)	描述实体类的作用，通常表示接口接收参数的实体对象
@ApiModelProperty	属性	描述实体类的属性，（用对象接收参数时，描述对象的一个字段）
@ApiOperation	方法	说明方法的用途、作用
@ApiImplicitParams	方法	表示一组参数说明
@ApiImplicitParam	方法	用在@ApiImplicitParams注解中，指定一个请求参数的各个方面的属性
@ApiParam	方法入参或者方法之上	单个参数的描述信息，描述form表单、url参数

@ApiImplicitParam注解详解：

属性	取值	作用
paramType		查询参数类型
	path	以地址的形式（rest风格）提交数据
	query	直接跟参数完成自动映射赋值(/add/user?name=zhangsan)
	body	以流的形式提交仅支持POST
	header	参数在request headers 里边提交
	form	以form表单的形式提交仅支持POST
dataType		参数的数据类型只作为标志说明，并没有实际验证
	Long
	String
name		接收参数名(方法入参的名称)
value		接收参数的意义描述（描述信息）
required		参数是否必填
	true	必填
	false	非必填
defaultValue		默认值

其它注解：

@ApiResponse：HTTP响应其中1个描述

@ApiResponses：HTTP响应整体描述

@ApiIgnore：使用该注解忽略这个API

@ApiError ：发生错误返回的信息

在项目工程为web资源添加注解支持（示例）

@RestController
@RequestMapping("/api")
@Api(value = "用户认证相关接口定义",tags = "用户功能-用户登录功能")
public class UserController {
    /**
     * 注入用户服务bean
     */
    @Autowired
    private UserService userService;
    /**
     * 根据用户名查询用户信息
     * @param userName
     * @return
     */
    @GetMapping("/{userName}")
    @ApiOperation(value = "根据用户名查询用户信息",notes = "用户信息查询",response = SysUser.class)
    @ApiImplicitParam(paramType = "path",name = "userName",value = "用户名",required = true)
    public SysUser getUserByUserName(@PathVariable("userName") String userName){
        return userService.getUserByUserName(userName);
    }
    /**
     * 用户登录功能接口
     * @param vo
     * @return
     */
    @PostMapping("/login")
    @ApiOperation(value = "用户登录功能",notes = "用户登录",response = R.class)
    public R<LoginRespVo> login(@RequestBody LoginReqVo vo){
        return userService.login(vo);
    }
    /**
     * 生成登录校验码的访问接口
     * @return
     */
    @GetMapping("/captcha")
    @ApiOperation(value = "验证码生成功能",response = R.class)
    public R<Map> getCaptchaCode(){
        return userService.getCaptchaCode();
    }
}

资源访问：http://localhost:8091/swagger-ui.html

在这里插入图片描述

2、knife4j

2.1 knife4j介绍

knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望它能像一把匕首一样小巧,轻量,并且功能强悍!

gitee地址：https://gitee.com/xiaoym/knife4j

官方文档：https://doc.xiaominfo.com/

效果演示：http://knife4j.xiaominfo.com/doc.html

核心功能

该UI增强包主要包括两大核心功能：文档说明和在线调试

文档说明：根据Swagger的规范说明，详细列出接口文档的说明，包括接口地址、类型、请求示例、请求参数、响应示例、响应参数、响应码等信息，使用 swagger-bootstrap-ui 能根据该文档说明，对该接口的使用情况一目了然。
在线调试：提供在线接口联调的强大功能，自动解析当前接口参数,同时包含表单验证，调用参数可返回接口响应内容、headers、Curl请求命令实例、响应时间、响应状态码等信息，帮助开发者在线调试，而不必通过其他测试工具测试接口是否正确,简介、强大。
个性化配置：通过个性化ui配置项，可自定义UI的相关显示信息
离线文档：根据标准规范，生成的在线markdown离线文档，开发者可以进行拷贝生成markdown接口文档，通过其他第三方markdown转换工具转换成html或pdf，这样也可以放弃swagger2markdown组件
接口排序：自1.8.5后，ui支持了接口排序功能，例如一个注册功能主要包含了多个步骤,可以根据swagger-bootstrap-ui提供的接口排序规则实现接口的排序，step化接口操作，方便其他开发者进行接口对接

2.2 项目集成knife4j

1)快速集成knife4j

在 MAVEN 工程添加依赖：
pom.xml

<!--knife4j的依赖-->
<dependency>
  <groupId>com.github.xiaoymin</groupId>
  <artifactId>knife4j-spring-boot-starter</artifactId>
</dependency>
<!--支持接口参数校验处理-->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

在swagger配置类添加knife4j配置：

@Configuration
@EnableSwagger2
@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class)
public class SwaggerConfiguration {
     //.....其它不变......
}

以上有两个注解需要特别说明，如下表：

注解	说明
`@EnableSwagger2`	该注解是Springfox-swagger框架提供的使用Swagger注解，该注解必须加
`@EnableKnife4j`	该注解是`knife4j`提供的增强注解,Ui提供了例如动态参数、参数过滤、接口排序等增强功能,如果你想使用这些增强功能就必须加该注解，否则可以不用加

2)访问在线文档资源：http://localhost:8091/doc.html

在这里插入图片描述