百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 博客教程 > 正文

在线API文档工具Knife4j简明使用教程

connygpt 2024-11-08 10:32 13 浏览

一、前言

在之前的项目中,在线api文档这一块一直使用的是swagger-ui这一款产品。但是其功能相对来说较为简单,而且没有我们一直想要的文档导出这一功能。为此我甚至尝试了解析swagger-ui的接口数据然后进行文档导出,但是实际效果并不是很理想。

后来我们get到了一款新的api工具:Knife4j,并准备在全项目中进行使用。


二、关于Knife4j

2.1、什么是Knife4j

他的前身是swagger-bootstrap-ui(一个简单的swagger-ui的皮肤项目),后面作者进行了升级整改,集成了swagger-ui的接口通用性解决方案。使得此项目能像匕首一样,小巧,轻快,便利。

附官方文档地址: Knife4j官方文档地址


三、Knife4j引入及相关配置

3.1、引入Maven


<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>2.0.7</version>
</dependency>

Java

Copy

3.2、创建Swagger配置项


@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {

    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .title("GUANGMUHUA API")
                        .description("guangmuhua web api")
                        .termsOfServiceUrl("http://www.guangmuhua.com.com/")
                        .contact("958356609@qq.com")
                        .version("1.0")
                        .build())
                /* 分组名称 */
                .groupName("2.X版本")
                .select()
                /* 这里指定Controller扫描包路径 */
                .apis(RequestHandlerSelectors.basePackage("com.XXX"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
}



四、项目代码部分配置

4.1、实体类修改示例如下

这里可以定义参数的名称以及使用Hidden来配置是否在接口中显示字段等。


@Data
@TableName("syslog")
public class SysLogEntity implements Serializable {

    private static final long serialVersionUID = 1L;

    @ApiModelProperty("数据ID")
    @TableId(value = "id", type = IdType.AUTO)
    private Long id;

    @ApiModelProperty("用户名")
    private String username;

}


4.2、controller中代码如下


@RestController
@Api(tags = "测试控制类")
@RequestMapping("/test")
public class XaTestController {

    /**
     * 功能描述:knife4j测试
     * Param: [noteEntity]
     * Return: com.com.xa.guangmuhua_api.modules.modules.utils.R
     */
    @PostMapping("/knife4jTest")
    @ApiOperation("knife4j测试")
    public R knife4jTest(@RequestBody NoteEntity noteEntity) {
        return R.ok();
    }
}


五、效果展示

5.1、在线访问

浏览器访问: IP + 端口 + doc.html,进入在线api界面。如下:

5.2、支持离线文档导出


5.3、接口概述



5.4、接口在线调试


六、后记

这里暂时对Knife4j做一个简明使用教程的记录,其实官网还有支持到更多的功能,有兴趣的同学可以直接查阅官方文档。

相关推荐

3分钟让你的项目支持AI问答模块,完全开源!

hello,大家好,我是徐小夕。之前和大家分享了很多可视化,零代码和前端工程化的最佳实践,今天继续分享一下最近开源的Next-Admin的最新更新。最近对这个项目做了一些优化,并集成了大家比较关注...

干货|程序员的副业挂,12个平台分享

1、D2adminD2Admin是一个完全开源免费的企业中后台产品前端集成方案,使用最新的前端技术栈,小于60kb的本地首屏js加载,已经做好大部分项目前期准备工作,并且带有大量示例代码,助...

Github标星超200K,这10个可视化面板你知道几个

在Github上有很多开源免费的后台控制面板可以选择,但是哪些才是最好、最受欢迎的可视化控制面板呢?今天就和大家推荐Github上10个好看又流行的可视化面板:1.AdminLTEAdminLTE是...

开箱即用的炫酷中后台前端开源框架第二篇

#头条创作挑战赛#1、SoybeanAdmin(1)介绍:SoybeanAdmin是一个基于Vue3、Vite3、TypeScript、NaiveUI、Pinia和UnoCSS的清新优...

搭建React+AntDeign的开发环境和框架

搭建React+AntDeign的开发环境和框架随着前端技术的不断发展,React和AntDesign已经成为越来越多Web应用程序的首选开发框架。React是一个用于构建用户界面的JavaScrip...

基于.NET 5实现的开源通用权限管理平台

??大家好,我是为广大程序员兄弟操碎了心的小编,每天推荐一个小工具/源码,装满你的收藏夹,每天分享一个小技巧,让你轻松节省开发效率,实现不加班不熬夜不掉头发,是我的目标!??今天小编推荐一款基于.NE...

StreamPark - 大数据流计算引擎

使用Docker完成StreamPark的部署??1.基于h2和docker-compose进行StreamPark部署wgethttps://raw.githubusercontent.com/a...

教你使用UmiJS框架开发React

1、什么是Umi.js?umi,中文可发音为乌米,是一个可插拔的企业级react应用框架。你可以将它简单地理解为一个专注性能的类next.js前端框架,并通过约定、自动生成和解析代码等方式来辅助...

简单在线流程图工具在用例设计中的运用

敏捷模式下,测试团队的用例逐渐简化以适应快速的发版节奏,大家很早就开始运用思维导图工具比如xmind来编写测试方法、测试点。如今不少已经不少利用开源的思维导图组件(如百度脑图...)来构建测试测试...

【开源分享】神奇的大数据实时平台框架,让Flink&amp;Spark开发更简单

这是一个神奇的框架,让Flink|Spark开发更简单,一站式大数据实时平台!他就是StreamX!什么是StreamX大数据技术如今发展的如火如荼,已经呈现百花齐放欣欣向荣的景象,实时处理流域...

聊聊规则引擎的调研及实现全过程

摘要本期主要以规则引擎业务实现为例,陈述在陌生业务前如何进行业务深入、调研、技术选型、设计及实现全过程分析,如果你对规则引擎不感冒、也可以从中了解一些抽象实现过程。诉求从硬件采集到的数据提供的形式多种...

【开源推荐】Diboot 2.0.5 发布,自动化开发助理

一、前言Diboot2.0.5版本已于近日发布,在此次发布中,我们新增了file-starter组件,完善了iam-starter组件,对core核心进行了相关优化,让devtools也支持对IAM...

微软推出Copilot Actions,使用人工智能自动执行重复性任务

IT之家11月19日消息,微软在今天举办的Ignite大会上宣布了一系列新功能,旨在进一步提升Microsoft365Copilot的智能化水平。其中最引人注目的是Copilot...

Electron 使用Selenium和WebDriver

本节我们来学习如何在Electron下使用Selenium和WebDriver。SeleniumSelenium是ThoughtWorks提供的一个强大的基于浏览器的开源自动化测试工具...

Quick &#39;n Easy Web Builder 11.1.0设计和构建功能齐全的网页的工具

一个实用而有效的应用程序,能够让您轻松构建、创建和设计个人的HTML网站。Quick'nEasyWebBuilder是一款全面且轻巧的软件,为用户提供了一种简单的方式来创建、编辑...