Java基础之SpringBoot整合knife4j

 更新时间:2021年05月13日 16:58:02   作者:不想做咸鱼的王富贵  
Swagger现在已经成了最流行的接口文档生成与管理工具,但是你是否在用的时候也在吐槽,它是真的不好看,接口测试的json数据没法格式化,测试地址如果更改了还要去改配置,接口测试时增加token验证是真的麻烦…针对Swagger的种种缺点,Knife4j就呼之欲出了.需要的朋友可以参考下

插件的特点

1、非常简洁清爽的UI设计,接口的快速搜索。

2、支持个性化设置,个性化设置包含:

 请求参数缓存
	  动态请求参数
	  RequestMapping接口过滤
	  HOST代理设置

3、全局参数设置,可以很方便的设置Token等权限认证参数。

4、离线API文档下载:

Markdown(已支持)
  Html(已支持)
  Word(已支持)
  OpenApi(已支持)

5、对 json 格式的数据有更好的支持,可以折叠展开等。

在这里插入图片描述在这里插入图片描述在这里插入图片描述在这里插入图片描述

knife4j官方文档地址 : https://doc.xiaominfo.com/knife4j/

导入pom依赖

<!--lombok插件-->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>

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

/**
 * 访问地址 http://127.0.0.1:2888/doc.html
 */
@Configuration
@EnableSwagger2
@EnableKnife4j
public class SwaggerConfig {


        @Bean
        public Docket createRestApi() {
            return  new Docket(DocumentationType.SWAGGER_2)
                    .useDefaultResponseMessages(false)
                    .apiInfo(apiInfo())
                    .select()
                    //方式一: 配置扫描 所有想在swagger界面的统一管理接口。都必须在此包下
                    //.apis(RequestHandlerSelectors.basePackage("com.baozun.dma.collection.delivery.controller"))
                    //方式二: 只有当方法上有  @ApiOperation 注解时才能生成对应的接口文档
               .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                    .paths(PathSelectors.any())
                    .build();

        }

        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title("Knife4j APIs")
                    .description("swagger-bootstrap-ui")
                    .termsOfServiceUrl("http://localhost:2888/")
                    .version("1.0")
                    .build();
        }

}

/**
 *  数据关系投递Controller
 * @author: wys
 * @create: 2021-05-08 14:20
 **/
@Api(value = "数据关系投递接口", tags = "数据关系投递接口")
@RestController("/MappingRelation")
public class MappingRelationController {

    @Autowired
    private MappingRelationManager mappingRelationManager;



    @GetMapping("/findList")
    @ApiOperation(value = "查看数据关系", tags = "数据关系投递接口")
    public List<MappingRelationManager> findList(){

        List<MappingRelationManager> list = mappingRelationManager.ListMappingRelation();
        return list;
    }


}

访问路径:http://127.0.0.1:2888/doc.html

到此这篇关于Java基础之SpringBoot整合knife4j的文章就介绍到这了,更多相关SpringBoot整合knife4j内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 浅谈java中==以及equals方法的用法

    浅谈java中==以及equals方法的用法

    这篇文章主要介绍了浅谈java中==以及equals方法的用法,涉及二者的用法示例,具有一定参考价值,需要的朋友可以了解下。
    2017-11-11
  • java实现直线分形山脉

    java实现直线分形山脉

    这篇文章主要为大家详细介绍了java实现直线分形山脉,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-01-01
  • Java编程Webservice指定超时时间代码详解

    Java编程Webservice指定超时时间代码详解

    这篇文章主要介绍了Java编程Webservice指定超时时间代码详解,简单介绍了webservice,然后分享了通过使用JDK对Webservice的支持进行Webservice调用实现指定超时时间完整示例,具有一定借鉴价值,需要的朋友可以参考下。
    2017-11-11
  • SpringBoot如何使用p6spy监控数据库

    SpringBoot如何使用p6spy监控数据库

    这篇文章主要介绍了SpringBoot如何使用p6spy监控数据库问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-01-01
  • Java更新调度器(update scheduler)的使用详解

    Java更新调度器(update scheduler)的使用详解

    Java更新调度器是Java中的一个特性,可以自动化Java应用程序的更新过程,它提供了一种方便的方式来安排Java应用程序的更新,确保其与最新的功能、错误修复和安全补丁保持同步,本文将深入介绍如何使用Java更新调度器,并解释它对Java开发人员和用户的好处
    2023-11-11
  • Java 生成二维码的工具资料整理

    Java 生成二维码的工具资料整理

    本文主要介绍Java 生成二维码的几种方法,这里给大家详细介绍了java生成二维码的三种工具,并附有示例代码供大家参考,开发java 二维码的朋友可以参考下
    2016-08-08
  • SpringBoot集成nacos动态刷新数据源的实现示例

    SpringBoot集成nacos动态刷新数据源的实现示例

    这篇文章主要介绍了SpringBoot集成nacos动态刷新数据源的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-12-12
  • Java实战宠物店在线交易平台的实现流程

    Java实战宠物店在线交易平台的实现流程

    读万卷书不如行万里路,只学书上的理论是远远不够的,只有在实战中才能获得能力的提升,本篇文章手把手带你用java+Springboot+maven+Mysql+FreeMarker实现一个宠物在线交易系统,大家可以在过程中查缺补漏,提升水平
    2022-01-01
  • redis实现多进程数据同步工具代码分享

    redis实现多进程数据同步工具代码分享

    这篇文章主要介绍了使用redis实现多进程数据同步工具的代码,大家参考使用吧
    2014-01-01
  • Java程序打包成带参数的jar文件实例代码

    Java程序打包成带参数的jar文件实例代码

    这篇文章主要介绍了Java程序打包成带参数的jar文件实例代码,需要的朋友可以参考下
    2017-09-09

最新评论