Swagger常用注解说明

柔情只为你懂 2023-10-08 12:57 40阅读 0赞

## Swagger: ##

#### @Api：用在请求的类上，表示对类的说明 ####

tags="说明该类的作用，可以在UI界面上看到的注解"
    value="该参数没什么意义，在UI界面上也看到，所以不需要配置"

#### @ApiOperation：用在请求的方法上，说明方法的用途、作用 ####

value="说明方法的用途、作用"
    notes="方法的备注说明"

#### @ApiImplicitParams：用在请求的方法上，表示一组参数说明 ####

#### @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面 ####

name：参数名
        value：参数的汉字说明、解释
        required：参数是否必须传
        paramType：参数放在哪个地方
            · header --> 请求参数的获取：@RequestHeader
            · query --> 请求参数的获取：@RequestParam
            · path（用于restful接口）--> 请求参数的获取：@PathVariable
            · body（不常用）
            · form（不常用）    
        dataType：参数类型，默认String，其它值dataType="Integer"       
        defaultValue：参数的默认值

#### @ApiResponses：用在请求的方法上，表示一组响应 ####

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

code：数字，例如400
        message：信息，例如"请求参数没填好"
        response：抛出异常的类

#### @ApiModel：用于响应类上，表示一个返回响应数据的信息 ####

（这种一般用在post创建的时候，使用@RequestBody这样的场景，
            请求参数无法使用@ApiImplicitParam注解进行描述的时候）

#### @ApiModelProperty：用在属性上，描述响应类的属性 ####

![在这里插入图片描述][20210706093534109.png]

[20210706093534109.png]: https://img-blog.csdnimg.cn/20210706093534109.png

发表评论取消回复

表情：

评论列表（有 0 条评论，40人围观）

还没有评论，来说两句吧...

相关阅读

相关 Swagger2-注解说明

Swagger2-注解说明文章目录 Swagger2-注解说明 swagger2 注解整体说明 1.@Api：请求类的说明

超、凢脫俗/ 2022年12月13日 04:14/ 0 赞/ 174 阅读

相关 swagger-ui常用注解

swagger-ui介绍： swagger-ui是一个通过注解自动生成接口文档的技术，这样我们在修改后端接口时，就可以将文档实时同步更新了下面我们来介绍一下常用的注解

朴灿烈づ我的快乐病毒、/ 2022年10月09日 03:29/ 0 赞/ 207 阅读

相关 Swagger 常用注解说明

Swagger 常用注解说明 <table> <thead> <tr> <th><strong>注解</strong></th> <th><st

悠悠/ 2022年06月02日 07:20/ 0 赞/ 290 阅读

相关 Swagger常用注解

1.这里面有几个常用到的注解 @Api：用在类上，说明该类的作用 @ApiOperation：用在方法上，说明方法的作用，标注在具体请求上，value和notes的作用差

蔚落/ 2022年05月20日 00:12/ 0 赞/ 353 阅读

相关 swagger常用注解说明

原文：[https://www.jianshu.com/p/12f4394462d5][https_www.jianshu.com_p_12f4394462d5] 常用到的注

朴灿烈づ我的快乐病毒、/ 2022年04月10日 07:39/ 0 赞/ 306 阅读

相关常用注解说明

常用注解 <table> <thead> <tr> <th>注解</th> <th>说明</th> </tr> </thead>

Dear 丶/ 2022年03月21日 11:22/ 0 赞/ 296 阅读

相关 Swagger2常用注解说明

这里只讲述@Api、@ApiOperation、@ApiImplicitParams、@ApiImplicitParam、@ApiParam、@ApiModel、@Ap

忘是亡心i/ 2022年02月04日 09:34/ 0 赞/ 314 阅读

相关 Swagger常用注解说明

1. @Api：用在请求的类上，表示对类的说明 tags="说明该类的作用，可以在UI界面上看到的注解" value="该参数没什么意

深藏阁楼爱情的钟/ 2022年01月30日 00:25/ 0 赞/ 295 阅读

相关 Swagger2常用注解说明

文章目录 Swagger2简介使用Swagger解决的问题 Spring Boot集成Swagger2 添加

末蓝、/ 2021年09月21日 09:34/ 0 赞/ 482 阅读

相关 swagger常用注解说明

常用到的注解有： Api ApiModel ApiModelProperty ApiOperation ApiParam ApiRes

淡淡的烟草味﹌/ 2021年09月15日 13:22/ 0 赞/ 502 阅读