Knife4j使用教程（四） -- Controller类的配置注解

已于 2023-10-28 20:29:51 修改
阅读量434 收藏
点赞数 1
分类专栏： # java 工具类 文章标签： java intellij-idea windows
于 2023-10-27 23:18:16 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/PUYALEI/article/details/134085103
版权
本文档详细介绍了 Knife4j 中用于Controller类的各种注解，包括@API、@ApiOperation、@ApiOperationSupport、@ApiParam、@ApiImplicitParams、@ApiIgnore等，用于构建和定制Swagger API文档。
摘要由CSDN通过智能技术生成

目录

1. @API注解

2. @ApiOperation()注解

3. @ApiOperationSupport注解

4. @ApiParam注解

5. @ApiImplicitParams注解 与 @ApiImplicitParam注解

6. @ApiIgnore()注解

1. @API注解

使用在类上，表明是swagger资源，@API拥有两个属性：value 、tags 、description。

  • tags ：生成的api 文档会根据tags分类，直白的说就是这个controller中的所有接口生成的接口文档都会在tags这个list下；tags如果有多个值，会生成多个list，每个list都显示所有接口。
@Api(tags = "列表1")
@Api(tags = {"列表1","列表2"})
  • value：该参数没什么意义，在UI界面上不显示，所以不用配置。
@RestController
@RequestMap
了解本专栏 订阅专栏 解锁全文 超级会员免费看
普雅^0^雷蒙达
关注
专栏目录
订阅专栏
Knife4j使用教程（三） -- 实体类的配置注解（@ApiModel与@ApiModelProperty 的 认识与使用）
PUYALEI的博客
10-27 1482
Knife4j使用教程（三） -- 实体类的配置注解（@ApiModel与@ApiModelProperty 的 认识与使用）
【SpringBoot】22、SpringBoot中整合knife4j接口文档
热门推荐
Asurplus
07-02 21万+
在项目开发中，web项目的前后端分离开发，APP开发，需要由前后端工程师共同定义接口，编写接口文档，之后大家都根据这个接口文档进行开发，到项目结束前都要一直维护 接口文档使得项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发，项目维护中或者项目人员更迭，方便后期人员查看、维护 一、界面先赏 1、首页 2、接口文档 3、调试 二、整合 knife4j 1、引入 maven 依赖 <!-- knife4j接口文档 start --> <dependency> &lt
权限管理后端篇(三)之Knife4j注解的使用
qq_57919779的博客
11-11 1351
Knife4j注解的使用
Knife4j—controller多包分组配置
helenbin14的博客
01-10 2980
注：我的一部分controller是在src/main/java/*/**/***/****/controller（路径1）下的不同包下，另一部分controller在src/main/java/*/**/***/generator（路径2）下，而且这2个部分的controller还有不同的子包，所以，我把路径1的所有controller路径放在一个Docket下，路径2的所有controller路径放在另一个Docket下，全部交给Spring管理，进行分组展示。2、Knife4j配置文件。
新手必看-Knife4j的常用注解
最新发布
天生我才总有用！！！
09-04 671
SpringBoot集成Knife4j可看另一篇文章：http://t.csdnimg.cn/bmPhj 添加在controller类上，可以指定该 controller 模块的名称。knife4j默认根据字母排序，加上序号后会根据序号排序。 该注解放在 controller 类下的请求方法上，可以指定该请求/方法的作用。添加后可以在对应的 控制层模块下查看该请求。 用于对请求方法的参数列表中那些未封装的参数进行说明。如果有多个参数时需要使用@Parameters包起来。
Knife4j常用注解
geimogo_的博客
04-22 4430
帮你少走半个月弯路确定不进来看看！
knife4j使用
PhilsphyPrgram的博客
02-26 602
这个是一个非常简单好用的java接口说明书,与Swagger2可以同时使用，这里我只介绍怎么使用 **1.**添加依赖 <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>2.0.4&lt
Springboot 3整合Knife4j（Swagger3、OpenApi3）
桃吱咬咬_的博客
07-08 3194
Springboot 3.x项目中使用Knife4j
Knife4j使用教程（一） -- 在不同版本SpringBoot，选用不同的Knife4j相关的jar包
PUYALEI的博客
10-26 694
【代码】Knife4j使用教程（一） -- 在不同版本SpringBoot，选用不同的Knife4j相关的jar包。
Knife4j使用教程（二） -- 配置Swagger相关信息
PUYALEI的博客
10-27 272
Knife4j使用教程（二） -- 配置Swagger相关信息
5.SpringBoot整合Swagger2(Knife4j框架) 及注解配置演示
机智的爆爆哥
08-10 2260
文章目录1. swagger是什么？2. 引入依赖3. 配置swagger4. 效果图5.注解配置5.1 @Api5.2 @ApiOperation5.3 @ApiImplicitParams5.4 @ApiImplicitParam5.5 @ApiParam5.6 @ApiResponses5.7 @ApiResponse5.8 @ApiModel5.9 @ApiModelProperty 1. swagger是什么？ 总的来说 就是一个接口文档 可支持调试 方便前后端的联调 功能强大 开发必不可少 话
Knife4j注解说明
weixin_45131680的博客
07-05 1139
【代码】Knife4j注解说明。
Spring Cloud集成knife4j文档接口详解
chongbaozhong的博客
04-30 4028
简介 knife4j是swagger的增强版，更契合微服务架构，ui前身是swagger-bootstrap-ui，api注解的使用方式和swagger一致。 Spring boot整合knife4j pom文件 <!-- 包含了ui界面 --> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter&lt
Knife4j的详细使用
Hanson的博客
02-22 2031
之前有写过swagger怎么使用的教程，但是现在很多项目用的接口文档其实是Knife4jKnife4j它是对swagger在线接口文档的一个增强，按照官网的话说就是给swagger做了一个更好看皮肤的同时加了一些新的功能，本章内容我会向大家介绍在项目中如整合knife4j以及一些使用的细节。Swagger-的使用(详细教程)如果你之前没有接使用过swagger的话，建议先看下上篇博客。关于Knife4j的介绍官方文档其实解释得很清楚了，我就简单 copy 一下了。Knife4j的前身是，前身是一个纯。
Knife4j--使用/教程/实例/配置
IT利刃出鞘的博客
10-13 7万+
本文用示例介绍knife4j的用法。（SpringBoot整合knife4j） Knife4j是一个很好用的接口文档工具。之前用过Swagger，觉得页面不太好，浏览技术网站时，偶然发现swagger-bootstrap-ui，它能将接口进行归类。
knife4j整合使用
K.X的博客
02-14 1199
每到项目验收或者给别人开放接口写接口文档就头疼的不行，参数多了还要一个一个去对；之前就想找有没有能到导出接口文档的工具，postman和swagger都不能实现。直到看到大佬推荐的 knife4j 。 使用： 使用和swagger类似。 1、在实体类中使用@ApiModel、@ApiModelProperty注解 2、controller中使用@Api、@ApiOperation、@ApiParam注解 第一步：在maven项目的pom.xml中引入Knife4j的依赖包，代码如下： <depende
knife4j使用与步骤
qq_48428343的博客
06-06 488
Knife4j 是一个针对Java MVC框架的Swagger增强解决方案，它主要用于帮助开发者生成和管理API文档。Knife4j 基于 Swagger（现在是OpenAPI Specification的一部分），提供了更友好的界面和更多的功能，使得API文档的生成和维护变得更加方便。
利用Knife4j注解实现Java生成接口文档
逐梦苍穹的博客
01-29 2712
本文介绍springboot集成Knife4j和swagger
knife4j-openapi3-jakarta-spring-boot-starter 使用范例
08-09
3. 在你的 Spring Boot 应用类上添加 `@EnableKnife4j` 注解，启用 Knife4j 的自动配置。例如： ```java import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure....
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值