热门标签 | HotTags
当前位置:  开发笔记 > 前端 > 正文

Java基础之SpringBoot整合knife4j

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依赖



    org.projectlombok
    lombok
    true



    com.github.xiaoymin
    knife4j-spring-boot-starter
    
    2.0.2


/**
 * 访问地址 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 findList(){

        List list = mappingRelationManager.ListMappingRelation();
        return list;
    }


}

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

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


推荐阅读
  • 本文详细介绍了Git分布式版本控制系统中远程仓库的概念和操作方法。通过具体案例,帮助读者更好地理解和掌握如何高效管理代码库。 ... [详细]
  • 本文详细记录了在基于Debian的Deepin 20操作系统上安装MySQL 5.7的具体步骤,包括软件包的选择、依赖项的处理及远程访问权限的配置。 ... [详细]
  • 探讨如何高效使用FastJSON进行JSON数据解析,特别是从复杂嵌套结构中提取特定字段值的方法。 ... [详细]
  • 深入理解Cookie与Session会话管理
    本文详细介绍了如何通过HTTP响应和请求处理浏览器的Cookie信息,以及如何创建、设置和管理Cookie。同时探讨了会话跟踪技术中的Session机制,解释其原理及应用场景。 ... [详细]
  • PHP 5.5.0rc1 发布:深入解析 Zend OPcache
    2013年5月9日,PHP官方发布了PHP 5.5.0rc1和PHP 5.4.15正式版,这两个版本均支持64位环境。本文将详细介绍Zend OPcache的功能及其在Windows环境下的配置与测试。 ... [详细]
  • Composer Registry Manager:PHP的源切换管理工具
    本文介绍了一个用于Composer的源切换管理工具——Composer Registry Manager。该项目旨在简化Composer包源的管理和切换,避免与常见的CRM系统混淆,并提供了详细的安装和使用指南。 ... [详细]
  • 本文介绍了如何利用npm脚本和concurrently工具,实现本地开发环境中多个监听服务的同时启动,包括HTTP服务、自动刷新、Sass和ES6支持。 ... [详细]
  • 本文探讨了在通过 API 端点调用时,使用猫鼬(Mongoose)的 findOne 方法总是返回 null 的问题,并提供了详细的解决方案和建议。 ... [详细]
  • 本文详细介绍如何在VSCode中配置自定义代码片段,使其具备与IDEA相似的代码生成快捷键功能。通过具体的Java和HTML代码片段示例,展示配置步骤及效果。 ... [详细]
  • 在网页开发中,页面加载速度是一个关键的用户体验因素。为了提升加载效率,避免在PageLoad事件中进行大量数据绑定操作,可以采用异步加载和特定控件来优化页面加载过程。 ... [详细]
  • 深入解析JMeter中的JSON提取器及其应用
    本文详细介绍了如何在JMeter中使用JSON提取器来获取和处理API响应中的数据。特别是在需要将一个接口返回的数据作为下一个接口的输入时,JSON提取器是一个非常有用的工具。 ... [详细]
  • 使用Numpy实现无外部库依赖的双线性插值图像缩放
    本文介绍如何仅使用Numpy库,通过双线性插值方法实现图像的高效缩放,避免了对OpenCV等图像处理库的依赖。文中详细解释了算法原理,并提供了完整的代码示例。 ... [详细]
  • 资源推荐 | TensorFlow官方中文教程助力英语非母语者学习
    来源:机器之心。本文详细介绍了TensorFlow官方提供的中文版教程和指南,帮助开发者更好地理解和应用这一强大的开源机器学习平台。 ... [详细]
  • 本文探讨了如何像程序员一样思考,强调了将复杂问题分解为更小模块的重要性,并讨论了如何通过妥善管理和复用已有代码来提高编程效率。 ... [详细]
  • 构建基于BERT的中文NL2SQL模型:一个简明的基准
    本文探讨了将自然语言转换为SQL语句(NL2SQL)的任务,这是人工智能领域中一项非常实用的研究方向。文章介绍了笔者在公司举办的首届中文NL2SQL挑战赛中的实践,该比赛提供了金融和通用领域的表格数据,并标注了对应的自然语言与SQL语句对,旨在训练准确的NL2SQL模型。 ... [详细]
author-avatar
小白学习哈
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有