自动生成接口文档(Swagger+Knife4j)

一.介绍

使用 Knife4j 自动生成接口文档有以下几个好处:

1. 快速且方便:Knife4j 可以根据你的代码注解自动生成接口文档,无需手动编写和更新文档内容。这样可以节省大量时间和工作量。

2. 实时同步:当你修改了接口的代码和注解后,Knife4j 会自动重新生成接口文档,保持文档与代码的实时同步,避免了文档与代码不一致的问题。

3. 易于阅读和理解:生成的接口文档会以直观、友好的界面呈现,包括清晰的接口路径、请求方法、参数信息、响应结果等。这样团队成员、开发者和测试人员能够更轻松地阅读和理解接口的使用方式和规范。

4. 提供交互式测试功能:Knife4j 不仅可以展示接口文档,还提供了交互式的测试功能。你可以直接在页面上进行接口的测试,输入参数并查看实时响应结果,方便测试和调试。

5. 提高协作效率:通过生成接口文档,团队成员可以更方便地了解接口的定义、参数要求和返回结果,减少了沟通成本和误解的可能性,提高协作效率。

总之,使用 Knife4j 自动生成接口文档能够帮助你节省时间、提高开发效率,同时改善团队协作和沟通。它是一个方便、实用的工具,值得推荐使用。

二.如何实现

第一步

导入knife4j的springboot  starter(该依赖内部已经封装了swagger和swagger-ui,所以不需要再导入swagger相关依赖)

第二步

导入完依赖,下一部当然是进行相关的配置啦~

我们新建一个config 类

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Knife4j 接口文档配置
 * https://doc.xiaominfo.com/knife4j/documentation/get_start.html
 * @author <a href="https://gitee.com/re_lq">RE_LQ</a>
 */
@Configuration
@EnableSwagger2
@Profile({"dev", "test"})
public class Knife4jConfig {

    @Bean
    public Docket defaultApi2() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .title("填入你想要的接口文档名称")
                        .description("填入你想要的描述")
                        .version("1.0")
                        .build())
                .select()
                // 指定 Controller 扫描包路径
                .apis(RequestHandlerSelectors
.basePackage("填入你项目的controller包路径"))
                .paths(PathSelectors.any())
                .build();
    }
}

三.可能会遇到的问题

注意,如果你使用的是Springboot 2.6.x版本及以上,那么它将与Swagger2  3.0.0版本发生冲突,运行项目将会发生报错:

org.springframework.context.ApplicationContextException:Failed to start bean 'documentationPluginsBootstrapper';nested

exception is java.lang.NullPointerException

解决办法

(1)在application.yml配置文件中添加以下配置即可解决版本冲突问题。

  # 支持 swagger3
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

 (2)降低Springboot版本到2.6以下(最笨的方法,当然也有用就对了)。

四.效果展示

启动项目,如图,输入地址:项目配置的端口号+context-path+/doc.html 即可访问自动生成的接口文档啦~

  • 3
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Spring Boot是一个用于创建独立的、基于生产级别的Spring应用程序的框架。它简化了Spring应用程序的配置和部署过程,并提供了一套强大的开发工具和约定,使开发人员能够更专注于业务逻辑的实现。 MyBatis Plus是MyBatis的增强工具,它提供了一系列的便利功能和增强特性,使得使用MyBatis更加简单和高效。它包括了代码生成器、分页插件、逻辑删除、乐观锁等功能,可以大大提高开发效率。 Redis是一个开源的内存数据库,它支持多种数据结构,如字符串、哈希、列表、集合、有序集合等。Redis具有高性能、高可用性和可扩展性的特点,常用于缓存、消息队列、分布式锁等场景。 Driver是指数据库驱动程序,它是用于连接数据库和执行SQL语句的软件组件。在Spring Boot中,我们可以通过配置数据源和引入相应的数据库驱动程序来实现与数据库的交互。 Knife4j是一款基于Swagger的API文档生成工具,它提供了更加美观和易用的界面,可以方便地查看和测试API接口。 Swagger是一套用于设计、构建、文档化和使用RESTful风格的Web服务的工具。它可以自动生成API文档,并提供了交互式的界面,方便开发人员进行接口测试和调试。 JWT(JSON Web Token)是一种用于身份验证和授权的开放标准。它通过在用户和服务器之间传递加密的JSON对象来实现身份验证和授权功能,避免了传统的基于Session的身份验证方式带来的一些问题。 Spring Security是Spring提供的一个安全框架,它可以集成到Spring Boot应用程序中,提供身份验证、授权、攻击防护等安全功能。通过配置Spring Security,我们可以实现对API接口的访问控制和权限管理。 关于Spring Boot + MyBatis Plus + Redis + Driver + Knife4j + Swagger + JWT + Spring Security的Demo,你可以参考以下步骤: 1. 创建一个Spring Boot项目,并引入相应的依赖,包括Spring Boot、MyBatis Plus、Redis、数据库驱动程序等。 2. 配置数据源和数据库驱动程序,以及MyBatis Plus的相关配置,如Mapper扫描路径、分页插件等。 3. 集成Redis,配置Redis连接信息,并使用RedisTemplate或者Jedis等工具类进行操作。 4. 集成Knife4jSwagger,配置Swagger相关信息,并编写API接口文档。 5. 集成JWT和Spring Security,配置安全相关的信息,如登录认证、权限管理等。 6. 编写Controller层的代码,实现具体的业务逻辑。 7. 运行项目,通过Swagger界面进行接口测试。 希望以上内容对你有帮助!如果还有其他问题,请继续提问。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值