Swagger2常用注解

于 2024-07-12 19:46:59 发布
阅读量59 收藏
点赞数 1
文章标签： spring boot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/R202471/article/details/140387297
版权

1.对接口类的说明：@Api(tags="")

2.对接口方法的说明：@ApiOperation(value="")

3.对接口参数的说明：@ApiImplicitParams(ApiImplicitParam(name="参数名"，value="参数的说明",required=是否必填，dataType="参数类型"))

4.对实体类的说明：@ApiModel(value="")

5.对属性说明：@ApiModelProperty(value="")

R202471
关注
  • 1
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Swagger常用注解使用说明
11-22
swagger 用户已api文档自动生成，可以大幅提高客户端和服务端的开发人员的协作效率。本资源主要描述了swagger 注解的使用方法。
Swagger 常用注解说明.docx
04-06
2. **@ApiOperation**: 这个注解用在请求的方法上，用于描述方法的用途和功能。`value` 参数表示方法的主要功能，`notes` 参数则可以添加更详细的注释。 示例： ```java @ApiOperation(value = "保存用户信息", ...
Swagger2常用注解说明
热门推荐
ThinkWon的博客
07-20 2万+
文章目录Swagger2简介使用Swagger解决的问题Spring Boot集成Swagger2添加依赖添加Swagger2Config配置类编写接口用户DTO用户controller访问接口文档Swagger2常用注解说明Controller相关注解@Api接口相关注解@ApiOperation@ApiParam@ApiImplicitParams@ApiImplicitParam@ApiResponses@ApiResponseModel相关注解@ApiModel@ApiModelProperty S
swagger2常用注解
咖啡味的小认真
11-08 605
主要分两个部分，控制器和实体类的注解 @Api：用在请求的类上，表示对类的说明 tags="说明该类的作用，可以在UI界面上看到的注解" value="该参数没什么意义，在UI界面上也看到，所以不需要配置" @ApiOperation：用在请求的方法上，说明方法的用途、作用 value="说明方法的用途、作用" notes="方法的备注说明" @ApiImplicitParams：用在请求的方法上，表示一组参数说明 @ApiImplicitParam：
Swagger2 常用注解
weixin_45038601的博客
07-20 297
Swagger2 常用注解@Api@ApiIgnore@ApiOperation@ApiParam@ApiModel@ApiProperty@ApiImplicitParam@ApiImplicitParams@ApiResponse@ApiResponses@ApiError@RequestParam@PathVariable@Api、@ApiOperation、@ApiParam 、 @RequestParam演示代码 @Api @Api： 用于类，标识这个类是swagger的资源。 @ApiIgno
四、Swagger2常用注解
付之一笑的专栏
05-15 1947
一、swagger2常用注解 1.1、Api @Api是类上注解。控制整个类生成接口信息的内容。 tags：类的名称。可以有多个值，多个值表示多个副本。 description：描述，已过时。 @RestController @RequestMapping(value = "/person") @Api(tags = {"PersonController","人员控制器"},description = "测试API类型描述信息") public class PersonController { 在swag
swagger2常用注解说明
蓝星花
03-12 3639
SpringBoot集成springfox-swagger2构建restful API SpringMVC集成springfox-swagger2构建restful API 常用注解： 1@Api()用于类； 表示标识这个类是swagger的资源 2@ApiOperation()用于方法； 表示一个http请求的操作 3@ApiParam()用于方法，参数，字段说明； 表示对参数的添加元数据（说明...
swagger2 常用注解
weixin_43944806的博客
10-22 821
一、@Api @Api注解放在类上面，这里的value是没用的，tags表示该controller的介绍。 二 、@ApiOperation @ApiOperation注解用于放在方法上面，其中value是说明该类的作用，notes一般是该方法的详细描述。 三、@RequestMapping、@GetMapping、@PostMapping、@PutMapping、@DeleteMapping 定...
swagger2常用注解详解
littleox_frighting的博客
07-02 1329
swagger常用注解
swagger2常用注解说明@Api
qq_32534441的博客
05-07 3521
https://blog.csdn.net/u014231523/article/details/76522486说明： 1.这里使用的版本：springfox-swagger2（2.4）springfox-swagger-ui （2.4） 2.这里是说明常用注解的含义和基本用法（也就是说已经对swagger进行集成完成） 没有集成的请参见 SpringBoot集成springfox-sw...
Swagger2 常用注解说明
Carson073的博客
12-09 484
整体说明 用于controller类上 注解 说明 @Api 协议集描述 方法上 注解 说明 @ApiOperation - @ApiImplicitParams 方法上 @A...
springboot整合Swagger2，构建接口管理界面
06-24
2、Swagger2常用注解 Api：修饰整个类，描述Controller的作用 ApiOperation：描述一个类的一个方法，或者说一个接口 ApiParam：单个参数描述 ApiModel：用对象来接收参数 ApiProperty：用对象接收参数时，描述对象的...
springboot-swagger2实战
08-02
2. 配置Swagger2：创建一个@Configuration注解的类，并在其中配置Swagger2的基本信息，如服务的基础路径、版本等。 3. 创建API文档：使用`@Api`、`@ApiOperation`、`@ApiParam`等注解，对Controller中的方法进行注释...
SpringBoot2 整合Swagger-UI
12-22
SpringBoot2 整合Swagger-UISwagger-UI常用注解整合Swagger-UI添加Swagger-UI的配置给Controller类添加Swagger注解启动项目，查看Swagger-UI文档参考文档 Swagger-UI Swagger-UI是HTML, Javascript, CSS的一个集合，...
spring boot 3.x版本中集成spring security 6.x版本进行实现动态权限控制解决方案
最新发布
C_AJing的博客
07-08 1179
框架会自动使用的方法进行用户加载，在加载用户以后，会在过滤器中的方法中，进行前端输入的用户信息和加载的用户信息进行信息对比。/*** 这里为了演示方便，模拟从数据库查询，直接设置一下权限");return new User("jack" , // 用户名称 new BCryptPasswordEncoder() . encode("123456") , //密码 list //权限列表);} }/**
Spring Boot与Spring MVC的区别和联系
技术研究中心
07-06 731
Spring Boot简化了Spring应用的开发过程，而Spring MVC则提供了构建Web应用的强大功能。Spring Boot集成了Spring MVC的所有功能，通过自动配置简化了Spring MVC应用的搭建过程。Spring Boot和Spring MVC是互补的技术，Spring Boot包含并扩展了Spring MVC。Spring Boot内置了Tomcat服务器，开发者无需额外配置，只需运行Spring Boot应用即可启动内置服务器并部署Spring MVC应用。
Spring Boot Security自定义AuthenticationProvider
2201_75600005的博客
07-08 494
在配置器中我们去实例化一个认证管理器AuthenticationManager，这个认证管理器中包含了两个认证器，分别是MobilecodeAuthenticationProvider（手机验证码）、DaoAuthenticationProvider（用户名密码）。下面的只是名字不同改成自己的provider名字即可。
Spring Boot集成olingo快速入门demo
HBLOG
07-06 561
Apache Olingo 是个 Java 库，用来实现 Open Data Protocol (OData)。Apache Olingo 包括服务客户端和 OData 服务器方面。
swagger3常用注解
09-20
swagger3常用注解包括： 1. @OpenAPIDefinition：定义OpenAPI规范的注解。 2. @Tag：用于对API进行分组和标记的注解。 3. @Operation：用于对API操作进行描述的注解。 4. @Parameter：用于定义API的参数的注解。 5. @RequestBody：用于定义API请求的请求体的注解。 6. @ApiResponse：用于定义API响应的注解。 7. @ApiModel：用于定义数据模型的注解。 8. @ApiModelProperty：用于定义数据模型属性的注解。 9. @Schema：用于定义数据模型的注解。 10. @Hidden：用于隐藏API接口的注解。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值