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实现账户取款和存款操作

    JAVA实现账户取款和存款操作

    这篇文章主要介绍了JAVA实现账户取款和存款操作,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-11-11
  • java代码效率优化方法(推荐)

    java代码效率优化方法(推荐)

    下面小编就为大家带来一篇java代码效率优化方法(推荐)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-01-01
  • Java实现快速排序和堆排序的示例代码

    Java实现快速排序和堆排序的示例代码

    这篇文章主要为大家详细介绍了快速排序和堆排序的多种语言的实现(JavaScript、Python、Go语言、Java、C++),感兴趣的小伙伴可以了解一下
    2022-12-12
  • Spring Cloud Eureka 注册与发现操作步骤详解

    Spring Cloud Eureka 注册与发现操作步骤详解

    这篇文章主要介绍了Spring Cloud Eureka 注册与发现操作步骤详解,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-03-03
  • SSH结合jquery实现三级联动效果

    SSH结合jquery实现三级联动效果

    这篇文章主要为大家详细介绍了SSH结合jquery实现三级联动效果,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-01-01
  • Java ThreadPoolExecutor的参数深入理解

    Java ThreadPoolExecutor的参数深入理解

    这篇文章主要介绍了Java ThreadPoolExecutor的参数深入理解的相关资料,需要的朋友可以参考下
    2017-03-03
  • Java 使用Axis调用WebService的示例代码

    Java 使用Axis调用WebService的示例代码

    这篇文章主要介绍了Java 使用Axis调用WebService的示例代码,帮助大家更好的理解和使用Java,感兴趣的朋友可以了解下
    2020-09-09
  • Java集合框架之Map详解

    Java集合框架之Map详解

    这篇文章主要为大家详细介绍了Java集合框架之Map,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-03-03
  • Java Condition条件变量提高线程通信效率

    Java Condition条件变量提高线程通信效率

    这篇文章主要介绍了Java Condition条件变量提高线程通信效率,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-10-10
  • 一文彻底搞懂Java和JDK的版本命名问题

    一文彻底搞懂Java和JDK的版本命名问题

    今天通过本文给大家分享我对Java的版本号以及JDK的命名的了解,通过实例图文展示给大家介绍的非常详细,需要的朋友跟随小编一起看看吧
    2021-06-06

最新评论