欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

Swagger给返回参数添加注释说明

程序员文章站 2022-07-02 21:56:02
...

处理效果

Swagger给返回参数添加注释说明

第一步,控制层加上注解

Swagger给返回参数添加注释说明

    @ApiResponses({
            @ApiResponse(code = 200,message = "OK",response = TrainUserTEntity.class),
    })

第二步,实体类属性上面加上注解

Swagger给返回参数添加注释说明

@ApiModelProperty(value = "姓名", required = true)

注解意义

Swagger注解aaa@qq.com 和 @ApiResponse

@ApiResponses

使用场景

在 Rest 接口上使用,用作返回值的描述

概述

一个包装器,允许列出多个 ApiResponse,若果你需要描述单个 ApiResponse,你仍然必须使用此注解并将@ApiResponse 包装在一个数组中

属性

Swagger给返回参数添加注释说明

@ApiResponse

使用场景

在 Rest 接口或类上和 @ApiResponses 组合使用,组装返回参数说明

概述

描述操作的可能响应,这可用于描述 Rest API 调用中可能的成功和错误 code 码。此注解可以在方法或类级别应用;仅当在方法级别或抛出时未定义相同代码的@ApiResponse注解时才会解析类级别注解异常,如果响应中使用了不同的响应类,则可以通过将响应类于响应码组合使用。注意swagger不允许单个响应代码的多个响应类型。此注解不直接使用,单独使用时swagger不会解析,应该和ApiResponses组合使用。

属性

Swagger给返回参数添加注释说明

相关标签: swagger