在项目实战中使用Knife4j API 管理

🎆 Knife4j API 管理

1、前言

​ 最近开发了一个Neo4j+elasticsearch+mysql作为数据库的后台管理系统，主要作用是利用图数据库的特性来存储不同学科中的知识点数据，该系统目前初版已开发完成，抱着将项目做得更好的想法，想要生成一套接口文档试试，以通过swagger了解到了Knife4j

2、Knife4j

Knife4j的前身是swagger-bootstrap-ui,前身swagger-bootstrap-ui是一个纯swagger-ui的ui皮肤项目

一开始项目初衷是为了写一个增强版本的swagger的前端ui,但是随着项目的发展,面对越来越多的个性化需求,不得不编写后端Java代码以满足新的需求,在swagger-bootstrap-ui的1.8.5~1.9.6版本之间,采用的是后端Java代码和Ui都混合在一个Jar包里面的方式提供给开发者使用.这种方式虽说对于集成swagger来说很方便,只需要引入jar包即可,但是在微服务架构下显得有些臃肿。

因此,项目正式更名为knife4j,取名knife4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍,更名也是希望把她做成一个为Swagger接口文档服务的通用性解决方案,不仅仅只是专注于前端Ui前端.

swagger-bootstrap-ui的所有特性都会集中在knife4j-spring-ui包中,并且后续也会满足开发者更多的个性化需求.

主要的变化是,项目的相关类包路径更换为com.github.xiaoymin.knife4j前缀,开发者使用增强注解时需要替换包路径

后端Java代码和ui包分离为多个模块的jar包,以面对在目前微服务架构下,更加方便的使用增强文档注解(使用SpringCloud微服务项目,只需要在网关层集成UI的jar包即可,因此分离前后端)

3、使用说明

​ 在项目中添加对应自己springboot版本的knife4j版本：

​ 本人的springboot版本为2.1.4所以选择knife4j版本为2.0.2，添加依赖：

 <dependency>
 	<groupId>com.github.xiaoymin</groupId>
 	<artifactId>knife4j-spring-boot-starter</artifactId>
 	<version>2.0.2</version>
 </dependency>

​ 如果开发者使用OpenAPI3的结构，底层框架依赖springfox3.0.0,可以考虑Knife4j的3.x版本

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <!--在引用时请在maven中央仓库搜索3.X最新版本号-->
    <version>3.0.3</version>
</dependency>

​ 想要使用更多功能需要使用springboot2.2x版本以上！！！！！！

​ 官方文档： https://doc.xiaominfo.com/knife4j/documentation/help.html

在所需要的微服务中添加如下config类：

代码：

package com.yxinmiracle.question.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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.HashSet