Swagger注解及其说明

最新推荐文章于 2025-01-03 05:30:00 发布
原创 最新推荐文章于 2025-01-03 05:30:00 发布 · 513 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#spring #web #java #swagger2 #api

本文详细介绍了Api、ApiOperation、ApiImplicitParams等注解在Java API开发中的作用，展示了如何使用@ApiResponses处理错误响应，并通过@ApiModel和ApiModelProperty阐述了模型定义。重点讲解了如何构建完整、易懂的API接口文档。
  • @Api : 用在类上，说明该类的主要作用。
  • @ApiOperation：用在方法上，给API增加方法说明。
  • @ApiImplicitParams : 用在方法上，包含一组参数说明。
  • @ApiImplicitParam：用来注解来给方法入参增加说明。

 

 

  • @ApiResponses：用于表示一组响应。

    • @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息

      • code：数字，例如400

      • ​message：信息，例如"请求参数没填好"

      • response：抛出异常的类

  • @ApiModel：用在返回对象类上，描述一个Model的信息（一般用在请求参数无法使用@ApiImplicitParam注解进行描述的时候）

  • @ApiModelProperty：描述一个model的属性

Yu17aa
关注
快速搭建Swagger（knife4j版）
灏的博客
12-28 1662
1.@Api：用于标注Controller类，表示该类是Swagger资源。2.@ApiOperation：用于标注Controller类的方法，表示该方法是一个ApiOperation，即API的一个操作。该注解包含以下属性：① value：ApiOperation的简要说明。②notes：ApiOperation的详细说明。③tags：指定API所属的标签，可以在Swagger UI中进行分类展示。
swagger常用注解汇总
初夏0811的博客
06-21 3万+
swagger中常用的注解及其使用位置如下：@Api：用在请求的类上，表示对类的说明常用参数代码示例： @ApiOperation：用在请求的方法上，说明方法的用途、作用代码示例： @ApiModel：用于响应类上，表示一个返回响应数据的信息 示例代码： @ApiModelProperty:用在属性上，描述响应类的属性代码示例： @ApiIgnore 忽略某个属性，使之不显示在swagger文档中显示...
Swagger2的基本配置和使用
a269441242的博客
12-22 1907
在目前前后端分离的模式中无论是前端开发还是后端开发基本上都被文档折磨过，前端开发经常会遇到后端接口改变，调整等文档未及时更新问题，而后端开发又会在文档的编写与维护上耗费大量的精力。 平时手写文档出现的问题： 文档需要更新的时候，需要再次发送一份给前端，也就是文档更新交流不及时。 接口返回结果不明确 不能直接在线测试接口，通常需要使用工具，比如：Postman 接口文档太多，不好管理 市场既然有需求，那么肯定就会有方案。解决方案多了就行成了标准，这就是Swagger的由来。 根据官网的介绍，Swagg.
swagger2注解使用方法
weixin_30404405的博客
09-20 458
swagger注解整体说明： @Api：用在请求的类上，表示对类的说明 tags="说明该类的作用，可以在UI界面上看到的注解" value="该参数没什么意义，在UI界面上也看到，所以不需要配置" @ApiOperation：用在请求的方法上，说明方法的用途、作用 value="说明方法的用途、作用" notes="方法的备注说明" ...
swagger参数注解
weixin_44594317的博客
10-16 857
swagger注解解说
Swagger常用注解使用说明
11-22
具体实现中，Swagger注解与SpringMvc的@RequestMapping、@GetMapping、@PostMapping等注解结合使用，可以详细描述每一个API端点的请求路径、请求类型、请求参数以及返回值等信息。这些信息不仅对API的消费者（如前端...
Swagger2 常用注解使用及其说明
li-shaoyu的博客
08-11 524
目录 Swagger2 常用注解使用及其说明 1、 Api 2、ApiModel 3、ApiModelProperty 4、ApiParam 5、ApiOperation 6、ApiResponse 和 ApiResponses 7、ApiImplicitParam 和 ApiImplicitParams Swagger2 常用注解使用及其说明 1、 Api @Api 用在类上，说明该类的作用。可以标记一个 Controller 类作为 Swagger 文档资源。 ...
springBoog和Swagger2使用的接口注解
01-28
本文将详细介绍一系列关键的接口注解及其应用场景，帮助读者更好地理解和运用这些注解来构建高质量的API。 #### 二、关键注解解析 ##### 1. @Api - **定义**：`@Api`注解主要应用于Controller类上，用于标识该类...
Swagger注解
最新发布
05-31
### Swagger注解的使用方法与示例 Swagger注解是用于描述API接口和参数的重要工具，它能够帮助开发者自动生成API文档[^1]。以下是关于如何使用Swagger注解以及一些常见的示例代码。 #### 1. 引入依赖 在使用...
Swagger学习⑦——@Parameter注解
一个写了10年bug的程序员日常笔记。
01-03 2787
Parameter注解是库的一部分，属于。它用于描述 API 操作中的参数，包括查询参数、路径参数、请求头参数等。通过@Parameter注解，可以为参数提供详细的元数据，例如描述、是否必需、示例值等，从而生成更清晰的 OpenAPI 文档。
Swagger学习⑧——@Parameters注解
一个写了10年bug的程序员日常笔记。
01-03 1500
注解是库的一部分，属于。它用于在 API 操作中同时描述多个参数。与@Parameter注解不同，是一个容器注解，可以包含多个@Parameter注解，从而更简洁地描述多个参数。
swagger 返回参数注解
小石头
12-17 9302
第一种 @ApiOperation(value = "取消/流失列表") @GetMapping("/getStudentLoseList") @ApiImplicitParams({ @ApiImplicitParam(paramType = "query", name = "type", value = "类型（0:取消分班 1:流失）",required = true,dataType = "int"), @ApiImplicitParam(paramType = "query".
Swagger2常用注解说明
chuhui1765的博客
06-20 586
这里只讲述@Api、@ApiOperation、@ApiImplicitParams、@ApiImplicitParam、@ApiParam、@ApiModel、@ApiModelProperty、ApiResponses、@ApiResponse这几个常用的。 一、@Api...
swagger详细配置说明
g200000的博客
12-07 5986
Swagger 是一个规范且完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。 Swagger 的目标是对 REST API 定义一个标准且和语言无关的接口，可以让人和计算机拥有无须访问源码、文档或网络流量监测就可以发现和理解服务的能力。当通过 Swagger 进行正确定义，用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与为底层编程所实现的接口类似，Swagger 消除了调用服务时可能会有的猜测...
swagger2 注解说明
weixin_43706468的博客
06-28 1318
swagger注解
Swagger给返回参数添加注释说明
热门推荐
qq_25983579的博客
02-27 5万+
处理效果 第一步,控制层加上注解 @ApiResponses({ @ApiResponse(code = 200,message = "OK",response = TrainUserTEntity.class), }) 第二步,实体类属性上面加上注解 @ApiModelProperty(value = "姓名", required = true) ...
Swagger使用的注解及其说明：
guo20082200的博客
01-12 1333
Swagger使用的注解及其说明： @Api：用在类上，说明该类的作用。 @ApiOperation：注解来给API增加方法说明。 @ApiImplicitParams : 用在方法上包含一组参数说明。 @ApiImplicitParam：用来注解来给方法入参增加说明。 @ApiResponses：用于表示一组响应 @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的...
Swagger2 关于Map参数在API文档中展示详细参数以及参数说明
netuser1937的博客
09-27 2948
Swagger2 关于Map参数在API文档中展示详细参数以及参数说明
Swagger配置详解
m0_58943936的博客
03-18 6019
讲解Swagger概念及作用 , 以及如何在项目中继承Swagger自动生成API文档
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值