美文网首页
swagger2 注解说明

swagger2 注解说明

作者: timothyue1 | 来源:发表于2020-09-22 20:47 被阅读0次
@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:用在属性上,描述响应类的属性

相关文章

  • swagger2注解使用教程

    swagger2 注解整体说明 1. @Api:用在请求的类上,说明该类的作用 示例@Api(tags="APP用...

  • Swagger2注解说明

    Swagger2注解说明 @Api():作用于类上,表示这个类是swagger的资源tags = ”说明该类的作用...

  • swagger2 注解说明

    @Api:用在请求的类上,表示对类的说明 @ApiOperation:用在请求的方法上,说明方法的用途、作用 @A...

  • swagger2 注解说明

  • swagger2 注解说明

    @Api:用在请求的类上,表示对类的说明 tags="说明该类的作用,可以在UI界面上看到的注解" value="...

  • springboot整合swagger2

    发现我们公司蛮喜欢用swagger2的,那就学习一波 swagger2是什么 简单来说,swagger2通过注解可...

  • Swagger2的实战

    一、Swagger2的官方文档 Swagger官方地址 二、Swagger2的相关注解的介绍 1、接口相关的描述 ...

  • Springboot+Swagger生成在线文档、离线文档

    生成在线文档(不细说,很多可用的教程) 加好注解接口的注解model的注解 生成离线文档 将Swagger2文档导...

  • springboot集成文档和校验

    一、springboot 集成swagger2 0. 添加依赖 1. 在model添加注解 注解常用字段以下: 2...

  • Springboot 整合swagger2 相关

    1、引入依赖 2、启动类加上注解 3、创建swagger2的工具类 4、在controller上用注解解释各个方法...

网友评论

      本文标题:swagger2 注解说明

      本文链接:https://www.haomeiwen.com/subject/lidgyktx.html