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实现五子棋AI算法

    Java实现五子棋AI算法

    这篇文章主要为大家详细介绍了Java实现五子棋AI算法,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-03-03
  • Java中线程Thread的三种方式和对比

    Java中线程Thread的三种方式和对比

    这篇文章主要介绍了Java中线程Thread的三种方式和对比,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-04-04
  • 浅谈Java解释器模式

    浅谈Java解释器模式

    这篇文章主要介绍了Java基于解释器模式实现定义一种简单的语言功能,简单描述了解释器模式的概念、功能及Java使用解释器模式定义一种简单语言的相关实现与使用技巧,需要的朋友可以参考下
    2021-10-10
  • Java垃圾回收之分代收集算法详解

    Java垃圾回收之分代收集算法详解

    今天小编就为大家分享一篇关于Java垃圾回收之分代收集算法详解,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2018-10-10
  • 使用idea将工具类打包使用的详细教程

    使用idea将工具类打包使用的详细教程

    这篇文章主要介绍了使用idea将工具类打包使用的详细教程,本文通过图文并茂给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-03-03
  • java基础的详细了解第一天

    java基础的详细了解第一天

    这篇文章对Java编程语言的基础知识作了一个较为全面的汇总,在这里给大家分享一下。需要的朋友可以参考,希望能给你带来帮助
    2021-08-08
  • 手把手带你了解Java-Stream流方法学习及总结

    手把手带你了解Java-Stream流方法学习及总结

    这篇文章主要介绍了通过实例了解JavaStream流的方法学习和总结,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2021-08-08
  • Struts2学习手册之文件上传基础教程

    Struts2学习手册之文件上传基础教程

    Struts2提供的文件上传下载机制十分简便,使得我们写很少的代码,下面这篇文章主要给大家介绍了关于Struts2学习手册之文件上传的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下
    2018-05-05
  • java构造器复用方式

    java构造器复用方式

    这篇文章主要介绍了java构造器复用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-03-03
  • 使用Assembly打包和部署SpringBoot工程方式

    使用Assembly打包和部署SpringBoot工程方式

    文章介绍了SpringBoot项目的两种部署方式:Docker容器部署和FatJar直接部署,FatJar部署存在配置文件隐藏和启动脚本复杂的问题,而Assembly打包方式可以解决这些问题,使得SpringBoot能够加载jar外的配置文件并提供服务化的启动脚本
    2024-12-12

最新评论