前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Springboot整合knife4j

Springboot整合knife4j

原创
作者头像
无敌小菜鸟
发布2021-12-29 14:03:14
9450
发布2021-12-29 14:03:14
举报
文章被收录于专栏:搬砖笔记搬砖笔记

新项目需要使用到swagger生成一些项目的接口信息,便于前端查看调试,所以这次采用了knife4j来作为项目的接口生成工具,顺便记录下使用笔记。

官方文档

地址:https://doc.xiaominfo.com/knife4j/action/springboot.html

提示:

  • 目前已经发行的Knife4j版本,Knife4j本身已经引入了springfox,开发者在使用时不用再单独引入Springfox的具体版本,否额会导致版本冲突。另外在网关层聚合(例如gateway)时,必须禁用Knife4j的增强模式
  • 使用Knife4j2.0.6及以上的版本,Spring Boot的版本必须大于等于2.2.x
  • 微服务聚合组件Knife4jAggregation强势发布,聚合OpenAPI文档太简单了
  • Knife4j独立运行版本Knife4jAggregationDesktop强势发布,使用Knife4j渲染OpenAPI文档很简单,详见文档

1.引入Knife4j的依赖包

代码语言:txt
复制
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>2.0.9</version>
</dependency>

<!-- https://mvnrepository.com/artifact/javax.validation/validation-api -->
<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>2.0.1.Final</version>
</dependency>

2.创建Swagger配置依赖

代码语言:txt
复制
@Configuration//配置类
@EnableSwagger2 //swagger注解
@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class) //knife4j需要引入
public class SwaggerConfig {
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("接口api工具")
                .description("系统接口API工具")
                .version("1.0")  //版本
                .license("xxxx")//所有者
                .build();//构造
    }
    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //分组名称
                .groupName("2.X版本")
                .select()
                //这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.tx.base.primary.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
}

3.启动项目

访问地址:http://127.0.0.1:8080/doc.html#/home

image.png
image.png

完!

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 官方文档
  • 1.引入Knife4j的依赖包
  • 2.创建Swagger配置依赖
  • 3.启动项目
相关产品与服务
云服务器
云服务器(Cloud Virtual Machine,CVM)提供安全可靠的弹性计算服务。 您可以实时扩展或缩减计算资源,适应变化的业务需求,并只需按实际使用的资源计费。使用 CVM 可以极大降低您的软硬件采购成本,简化 IT 运维工作。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档