精雕细琢的文档体验：Spring Boot 与 Knife4j 完美交汇

欢迎来到我的博客，代码的世界里，每一行都是一个故事

精雕细琢的文档体验：Spring Boot 与 Knife4j 完美交汇

    • 前言
    • Knife4j 与 Swagger 的区别
      • 1. 特性与优劣势对比：
        • Knife4j：
        • Swagger：
      • 2. 选择 Knife4j 的理由：
    • Knife4j中的注解说明
      • 1. 控制器类相关注解：
        • `@Api` 注解：
      • 2. 接口方法相关注解：
        • `@ApiOperation` 注解：
        • `@ApiParam` 注解：
      • 3. 模型类相关注解：
        • `@ApiModel` 注解：
        • `@ApiModelProperty` 注解：
    • 实战演示
      • 引入maven依赖
      • 配置类
      • 请求vo实现
      • 响应VO实现
      • controller实现
      • 效果展示图
    • 彩蛋(报错 解决)
    • 结语：

前言

在代码的世界里，有时候注释不足以表达你的思想，而一份优雅的 API 文档则能够让你的代码更加生动、易读。今天，我们将探讨如何通过整合 Knife4j，为你的 Spring Boot 项目添加一把锐利的文档利器。就像在一场精彩的武术表演中，每一刀都能展现出独特的艺术魅力，Knife4j 也将为你的文档世界带来新的精彩。

Knife4j 与 Swagger 的区别

Knife4j 和 Swagger 是两个用于 API 文档生成和展示的工具，它们都基于 OpenAPI（以前称为 Swagger）规范。下面是 Knife4j 与 Swagger 的区别以及对比它们的特性和优劣：

1. 特性与优劣势对比：

Knife4j：

特性：

  1. UI 界面美观： Knife4j 提供了一套漂亮的、易用的 UI 界面，展示了 API 文档的信息，并支持在线调试和测试。

  2. 支持多种注解： Knife4j 支持众多的 Swagger 注解，并且提供了一些额外的扩展注解，如 @ApiImplicitParams、@ApiOperationSupport 等。

  3. 在线调试： 提供了在线调试和测试 API 的功能，开发者可以直接在文档中进行接口的测试。

  4. 强大的扩展性： 支持自定义扩展，开发者可以根据需求进行定制化。

优势：

  • UI 界面美观，易用性好。
  • 支持丰富的 Swagger 注解，提供了更多的功能。
  • 提供了在线调试功能，方便开发者测试接口。
Swagger：

特性：

  1. 标准化规范： Swagger 是 OpenAPI 规范的实现之一，具有广泛的支持和社区。

  2. 生态系统丰富： 由于是较早的 API 文档工具，有庞大的社区和丰富的插件生态系统。

  3. 强大的生态支持： 支持多种语言和框架，适用于各种项目。

优势：

  • 作为 OpenAPI 规范的实现，与其他支持 OpenAPI 的工具和库更好地集成。
  • 有着较长时间的发展历史，生态系统较为成熟。

2. 选择 Knife4j 的理由：

  1. UI 界面更友好： Knife4j 的 UI 界面相较于原生 Swagger 更加美观和易用，提供了更好的用户体验。

  2. 功能扩展更丰富： Knife4j 在 Swagger 的基础上进行了功能扩展，支持更多的 Swagger 注解和一些额外的扩展注解，提供了更多的功能。

  3. 在线调试更方便： Knife4j 提供了在线调试和测试 API 的功能，方便开发者在文档中直接进行接口测试。

  4. 社区支持良好： 尽管相对于 Swagger，Knife4j 的用户规模可能较小，但其社区仍然活跃，能够提供一定的支持。

综合考虑上述因素，选择 Knife4j 的主要理由在于其更友好的 UI 界面、丰富的功能扩展和方便的在线调试功能。然而，具体选择应该根据项目需求、开发者团队的偏好以及其他因素来决定。

Knife4j中的注解说明

Knife4j 中的注解主要用于配置和描述 API 文档。这些注解帮助开发者更精确地定义 API 接口、模型类等信息，以便生成详细的 API 文档。以下是一些在 Knife4j 中常用的注解及其作用：

1. 控制器类相关注解：

@Api 注解：

@Api 注解用于对整个控制器类进行描述，指定一些全局信息，如分组、描述等。

@Api(tags = "示例接口", description = "用于演示 Knife4j 的 API 接口")
@RestController
@RequestMapping("/api")
public class SampleController {// ...
}
  • tags：指定分组，用于在文档中对接口进行分类展示。
  • description：对整个控制器的描述。

2. 接口方法相关注解：

@ApiOperation 注解：

@ApiOperation 注解用于对单个接口方法进行描述，指定该接口的一些信息，如标题、说明等。

@ApiOperation(value = "获取 Hello 信息", notes = "这是一个示例接口，返回 'Hello, Knife4j!'")
@GetMapping("/hello")
public String getHelloMessage() {return "Hello, Knife4j!";
}
  • value：接口的标题。
  • notes：接口的详细说明。
@ApiParam 注解：

@ApiParam 注解用于对接口方法的参数进行描述，指定参数的一些信息，如名称、是否必须、描述等。

@GetMapping("/greet")
@ApiOperation(value = "根据名称问候", notes = "根据传入的名称返回问候语")
public String greet(@ApiParam(value = "姓名", required = true) @RequestParam String name) {return "Hello, " + name + "!";
}
  • value：参数的描述。
  • required：指定参数是否是必须的。

3. 模型类相关注解：

@ApiModel 注解：

@ApiModel 注解用于对模型类进行描述，指定模型的一些信息，如描述、子类等。

@ApiModel(description = "用户信息")
public class User {// ...
}
  • description：模型的描述。
@ApiModelProperty 注解：

@ApiModelProperty 注解用于对模型类的属性进行描述，指定属性的一些信息，如描述、示例值等。

public class User {@ApiModelProperty(value = "用户ID", example = "123")private Long id;@ApiModelProperty(value = "用户姓名", example = "John Doe")private String name;// ...
}
  • value：属性的描述。
  • example：属性的示例值。

这些注解使得 Knife4j 能够生成更加详细、清晰的 API 文档。在实际应用中，结合这些注解，可以使 API 文档更具可读性和易用性。

实战演示

引入maven依赖

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

配置类

package fun.todoitbo.botally.config;import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;/*** @author xiaobo*/
@Configuration
@EnableSwagger2
public class Knife4jConfiguration {@Bean(value = "defaultApi2")public Docket defaultApi2() {// 设置分组名称String groupName="记账API";// 创建 Docket 对象Docket docket=new Docket(DocumentationType.OAS_30).apiInfo(new ApiInfoBuilder().title("记账 API ").description("# 关于记账软件的 API").contact(new Contact("一只牛博","https://todoitbo.fun","todoitbo@qq.com")).version("3.0").build())// 设置分组名称.groupName(groupName).select()// 指定Controller扫描包路径.apis(RequestHandlerSelectors.basePackage("fun.todoitbo.botally.controller")).paths(PathSelectors.any()).build();return docket;}}

请求vo实现

package fun.todoitbo.botally.vo;import com.fasterxml.jackson.annotation.JsonFormat;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;import java.time.LocalDateTime;/*** 用户账单表(TbBill)实体类** @author todoitbo* @since 2024-01-03 13:57:52*/
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class GetTbBillReqVo {@ApiModelProperty(value = "账单主键id")private Long id;@ApiModelProperty(value = "账单类别id")private Long categoryId;@ApiModelProperty(value = "最小金额")private Double minAmount;@ApiModelProperty(value = "最大金额")private Double maxAmount;@ApiModelProperty(value = "名称")private String name;@ApiModelProperty(value = "开始时间")@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")private LocalDateTime startTime;@ApiModelProperty(value = "结束时间")@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")private LocalDateTime endTime;@ApiModelProperty(value = "账单出账")private int inBill;@ApiModelProperty(value = "账单时间")@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")private LocalDateTime belongTime;}

响应VO实现

package fun.todoitbo.botally.vo;import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;import java.math.BigDecimal;
import java.time.LocalDateTime;/*** @author todoitbo* @date 2024/1/3*/
@Data
public class TbBillRespVo {@ApiModelProperty(value = "账单ID，主键")@JsonSerialize(using = ToStringSerializer.class)private Long id;@ApiModelProperty(value = "账单类别id")@JsonSerialize(using = ToStringSerializer.class)private Long categoryId;@ApiModelProperty(value = "账单时间")@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")private LocalDateTime billTime;@ApiModelProperty(value = "金额")private BigDecimal amount;@ApiModelProperty(value = "名称")private String name;@ApiModelProperty(value = "账单类别名称")private String categoryName;@ApiModelProperty(value = "是否收入")private int inBill;
}

controller实现

package fun.todoitbo.botally.controller;import fun.todoitbo.botally.dto.BoResult;
import fun.todoitbo.botally.service.ITbBillService;
import fun.todoitbo.botally.vo.DetailRespVo;
import fun.todoitbo.botally.vo.GetTbBillReqVo;
import fun.todoitbo.botally.vo.SaveTbBillReqVo;
import fun.todoitbo.botally.vo.TbBillRespVo;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;import javax.annotation.Resource;
import javax.validation.constraints.NotNull;
import java.util.List;/*** 用户账单表(TbBill)控制器** @author todoitbo* @since 2024-01-03 13:57:52*/
@RestController
@RequestMapping(value = "TbBill")
@Api(tags = "用户账单表(TbBill)控制器")
@Validated
public class TbBillController {@Resourceprotected ITbBillService service;@PostMapping("/saveBill")@ApiOperation(value = "新增账单")public BoResult<Boolean> saveBill(@Validated @RequestBody SaveTbBillReqVo saveTbBillReqVo) {return BoResult.resultOk(service.saveBill(saveTbBillReqVo));}@DeleteMapping("/deleteBill")@ApiOperation(value = "删除账单")public BoResult<Boolean> deleteBill(@NotNull(message = "id不能为空") Long id) {return BoResult.resultOk(service.deleteBill(id));}@GetMapping("/getBillList")@ApiOperation(value = "获取账单列表")public BoResult<List<TbBillRespVo>> getBillList(@Validated GetTbBillReqVo getTbBillReqVo) {return BoResult.resultOk(service.getBillList(getTbBillReqVo));}@GetMapping("/getDetail")@ApiOperation(value = "获取账单详情")public BoResult<DetailRespVo> getDetail() {return BoResult.resultOk(service.getDetail());}
}

效果展示图

在这里插入图片描述

彩蛋(报错 解决)

在这里插入图片描述

这个报错是因为springboot版本高，由于现代浏览器和中间件对URL的敏感性增加，一些场景下使用ant风格的URL匹配可能会出现问题。因此，为了保证最大的兼容性和可移植性，建议在Spring Boot项目中添加这个配置。

spring:mvc:pathmatch:matching-strategy: ant_path_matcher

结语：

希望通过这篇文章，你能够更深入地了解 Knife4j 在 Spring Boot 中的应用。在文档的世界里，每一刀都是为了更好地表达思想，而 Knife4j 就是我们的得力助手。让我们一同投入这场文档的舞台，为代码增色不少，为开发带来更多的便利与乐趣。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.hqwc.cn/news/453918.html

如若内容造成侵权/违法违规/事实不符，请联系编程知识网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

JVM-双亲委派机制

JVM-双亲委派机制

双亲委派机制定义 双亲委派机制指的是&#xff1a;当一个类加载器接收到加载类的任务时&#xff0c;会自底向上查找是否加载过&#xff0c; 再由顶向下进行加载。 详细流程 每个类加载器都有一个父类加载器。父类加载器的关系如下&#xff0c;启动类加载器没有父类加载器&am…
阅读更多...
CSS 闪电按钮效果

CSS 闪电按钮效果

<template><view class="const"><div class="voltage-button"><button>闪电按钮</button><svg version="1.1" xmlns="http://www.w3.org/2000/svg" x="0px" y="0px" viewBox=&q…
阅读更多...
数据挖掘实战-基于决策树算法构建北京市空气质量预测模型

数据挖掘实战-基于决策树算法构建北京市空气质量预测模型

&#x1f935;‍♂️ 个人主页&#xff1a;艾派森的个人主页 ✍&#x1f3fb;作者简介&#xff1a;Python学习者 &#x1f40b; 希望大家多多支持&#xff0c;我们一起进步&#xff01;&#x1f604; 如果文章对你有帮助的话&#xff0c; 欢迎评论 &#x1f4ac;点赞&#x1f4…
阅读更多...
PbootCMS采集插件使用教程

PbootCMS采集插件使用教程

这篇Pboot采集教程教你使用PbootCMS采集插件&#xff0c;自动批量采集网页文章数据&#xff0c;并发布到PbootCMS系统&#xff0c;快速丰富网站的内容。 1. 下载并安装PbootCMS采集插件 1-1&#xff09;PbootCMS采集插件免费下载&#xff1a;Pboot采集插件-PbootCMS发布模块下…
阅读更多...
数据可视化Tableau

数据可视化Tableau

目录 一.第一次实验课内容 1、熟悉Tableau Desktop的工作环境。 2、熟悉数据导入、维度和度量的区分以及不同数据字段类型的标识符。 3、熟悉工作表的基本操作&#xff0c;主要包括行列功能区&#xff0c;标记卡&#xff0c;筛选器&#xff0c;智能推荐的使用。 4、作业--…
阅读更多...
深入解析Elasticsearch的内部数据结构和机制：行存储、列存储与倒排索引之行存（一）

深入解析Elasticsearch的内部数据结构和机制：行存储、列存储与倒排索引之行存（一）

在当今的大数据时代&#xff0c;高效的数据检索和分析能力已成为许多应用程序的核心需求。Elasticsearch&#xff0c;作为一款强大的分布式搜索和分析引擎&#xff0c;正是为了满足这些需求而诞生的。它之所以能够在海量数据中实现毫秒级的搜索响应&#xff0c;以及灵活的数据分…
阅读更多...
【Shell的运行原理以及Linux当中的权限问题】

【Shell的运行原理以及Linux当中的权限问题】

Shell的运行原理以及Linux当中的权限问题 Shell的运行原理Linux当中的权限问题Linux权限的概念如何实现用户账号之间的切换如何仅提升当前指令的权限如何将普通用户添加到信任列表 Linux权限管理文件访问者的分类 (人)文件类型和访问权限 (事物属性)文件权限值的表示方法文件访…
阅读更多...
常用排序算法（Java版本）

常用排序算法（Java版本）

1 引言 常见的排序算法有八种&#xff1a;交换排序【冒泡排序、快速排序】、插入排序【直接插入排序、希尔排序】、选择排序【简单选择排序、堆排序】、归并排序、基数排序。 2 交换排序 所谓交换&#xff0c;就是序列中任意两个元素进行比较&#xff0c;根据比较结果来交换…
阅读更多...
QT Linux下无法使用CTRL+ALT+P快捷键，不生效

QT Linux下无法使用CTRL+ALT+P快捷键，不生效

文章目录 一、背景二、排查&#xff08;1&#xff09;检查创建&#xff0c;发现没问题。&#xff08;2&#xff09;查看 shortcutMap 是否注册&#xff08;3&#xff09;排查xcb有没有获取到该事件&#xff08;4&#xff09;排查是否是系统的问题&#xff08;5&#xff09;www.…
阅读更多...
【Java】DI依赖注入详解

【Java】DI依赖注入详解

DI注入时有以下几种方式 1、属性注入&#xff1a;Autowired注解 通过Autowired直接进行属性注入 Service public class UserService {public void sayHi(){System.out.println("Hi,service");} } Controller public class UserController {Autowiredprivate Use…
阅读更多...
docker核心技术

docker核心技术

一. 从系统架构谈起 传统分层架构 vs 微服务 微服务改造 分离微服务的方法建议： 审视并发现可以分离的业务逻辑业务逻辑，在对业务领域不是特别熟悉的时候，按照部门职能进行划分，例如账号、财务等寻找天生隔离的代码模块，可以借助于静态代码分析工具如果可以闭环的解决一…
阅读更多...
蓝桥杯Web应用开发-display属性

蓝桥杯Web应用开发-display属性

display 属性 专栏持续更新中 display 属性可以用来设置元素在页面上的排列方式&#xff0c;也可用来隐藏元素。 display 属性值的说明如下表所示。 属性值说明block元素以块级方式展示。inline元素以内联方式展示。inline-block元素以内联块的方式展示。none隐藏元素。 b…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023