一、开源项目简介

Knife4j是一个集Swagger2和OpenAPI3为一体的增强解决方案

帮助开发者快速聚合使用OpenAPI规范

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

knife4j的前身是swagger-bootstrap-ui，为了契合微服务的架构发展,由于原来swagger-bootstrap-ui采用的是后端Java代码+前端Ui混合打包的方式,在微服务架构下显的很臃肿,因此项目正式更名为knife4j

更名后主要专注的方面

• 前后端Java代码以及前端Ui模块进行分离,在微服务架构下使用更加灵活
• 提供专注于Swagger的增强解决方案,不同于只是改善增强前端Ui部分
• 提供更多灵活的中间件方案\工具

二、开源协议

使用Apache-2.0开源协议

三、界面展示

四、功能概述

基础特性

• 兼容OpenAPI 2.0
• 兼容OpenAPI 3.0

增强扩展

• 基础ui组件(自定义文档、动态参数调试、I18n、接口排序、导出等)
• 基于Springfox框架+Swagger2规范的自动注入starter
• 基于Springdoc-openapi+OAS3规范的自动注入starter
• 提供对主流网关组件的统一聚合OpenAPI接口文档的解决方案

框架适配

• 适配兼容Spring MVC
• 适配兼容Spring Boot 2.2、2.3、2.4、2.5、2.6、2.7、3.0
• 适配兼容Spring WebFlux
• 基于SpringFox2.x版本提供Swagger2规范的增强扩展
• 基于Springdoc-openapi项目提供OAS3规范的增强扩展

社区生态

• 基于Servlet体系的微服务聚合中间件Knife4jAggregation
• 基于Spring Cloud Gateway网关聚合的微服务聚合中间件
• 独立运行的中间件Knife4jDesktop

项目模块

目前仓库主要的模块说明：

模块名称

说明

knife4j

为Java MVC框架集成Swagger的增强解决方案，Java生态下的中间件封装

knife4j-insight

开箱即用的独立解决方案,提供官方Docker镜像,基于Spring Boot 3.0编写，查看使用文档

knife4j-doc

knife4j官方文档，基于Docusaurus编写，参与贡献请参考文档

knife4j-vue

当前Knife4j的前端源码，基于Vue2.0编写

knife4j-vue3

当前Knife4j的前端源码，基于Vue3.0编写，该代码库来自贡献者，目前尚未投入使用

knife4j-front

knife4j的前端架构代码,目前是规划阶段，该模块尚未编码,有想法的可以通过交流群与作者沟通

五、技术选型

快速开始(Spring Boot 2 + OpenAPI2)

不同规范以及Spring Boot3 OpenAPI3的使用请移步详细文档

第一步：创建Spring Boot项目并且在pom.xml中引入Knife4j的依赖包，代码如下：

<!--引入Knife4j的官方start包,该指南选择Spring Boot版本<3.0,开发者需要注意-->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-openapi2-spring-boot-starter</artifactId>
    <version>4.0.0</version>
</dependency>

第二步：创建Swagger配置依赖，代码如下：：

@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {

    @Bean(value = "dockerBean")
    public Docket dockerBean() {
        //指定使用Swagger2规范
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                //描述字段支持Markdown语法
                .description("# Knife4j RESTful APIs")
                .termsOfServiceUrl("https://doc.xiaominfo.com/")
                .contact("xiaoymin@foxmail.com")
                .version("1.0")
                .build())
                //分组名称
                .groupName("用户服务")
                .select()
                //这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.github.xiaoymin.knife4j.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
}

第三步:新建一个接口Controller类，如下：

@Api(tags = "首页模块")
@RestController
public class IndexController {

    @ApiImplicitParam(name = "name",value = "姓名",required = true)
    @ApiOperation(value = "向客人问好")
    @GetMapping("/sayHi")
    public ResponseEntity<String> sayHi(@RequestParam(value = "name")String name){
        return ResponseEntity.ok("Hi:"+name);
    }
}

万事俱备，启动Spring Boot项目，浏览器访问Knife4j的文档地址即可查看效果

http://localhost:8080/doc.html