Swagger 注解~用于方法

@ApiOperation 用于方法；表示一个http请求的操作
value用于方法描述
notes用于提示内容
tags可以重新分组（视情况而用）
@ApiParam 用于参数，字段说明；表示对参数的添加元数据（说明或是否必填等）
name–参数名
value–参数说明
required–是否必填

@Api(value="用户controller",tags={"用户操作接口"})
@RestController
public class UserController {@ApiOperation(value="获取用户信息",tags={"获取用户信息copy"},notes="注意问题点")@GetMapping("/getUserInfo")public User getUserInfo(@ApiParam(name="id",value="用户id",required=true) Long id,@ApiParam(name="username",value="用户名") String username) {// userService可忽略，是业务逻辑User user = userService.getUserInfo();return user;}
}

效果图：

Swagger 注解~用于方法相关推荐

Swagger 注解~用于Controller
@Api 用于类:表示标识这个类是swagger的资源 tags–表示说明 value–也是说明,可以使用tags替代但是tags如果有多个值,会生成多个list @Api(value=" ...
Swagger 注解~用于模型
@ApiModel 用于模型类 :表示对类进行说明,用于参数用实体类接收 value–表示对象名 description–描述都可省略 @ApiModelProperty 用于字段: 表示对mode ...
swagger注解说明_swagger2常用注解说明
原文:https://blog.csdn.net/u014231523/article/details/76522486 说明: 1.这里使用的版本:springfox-swagger2(2.4)sp ...
什么是swagger以及swagger注解详解
1.什么是swagger Swagger是一个规范和完整的框架,用于生成.描述.调用和可视化RESTful风格的Web服务.简单来说,Swagger是一个功能强大的接口管理工具,并且提供了多种编程语言 ...
【swagger】Swagger注解介绍
Swagger注解介绍 1.swagger注解 @ApiModel: 用于类,表示对类进行说明,用于参数用实体类接收 @ApiProperty:用于字段,表示对model属性的说明或者数据操作更改 @ ...
Spring注解使用方法
Spring框架从创建伊始就致力于为复杂问题提供强大的.非侵入性的解决方案.Spring 2.0当中为缩减XML配置文件数量引入定制命名空间功能,从此它便深深植根于核心Spring框架(aop.con ...
【EventBus】事件通信框架 ( 实现几个关键的封装类 | 消息中心 | 订阅注解 | 订阅方法封装 | 订阅对象-方法封装 | 线程模式 )
文章目录一.消息中心二.订阅方法时的注解三.订阅方法封装四.订阅对象-方法封装五.线程模式一.消息中心此处暂时只实现一个单例类 , 后续注册订阅者 , 处理事件传递 , 取消注册订阅者 ...
Swagger 注解~其他
@ApiIgnore 用于类或者方法上,可以不被swagger显示在页面上比较简单, 这里不做举例 @ApiImplicitParam 用于方法,表示单独的请求参数 @ApiImplicitPar ...
spring同一个类中，一个方法调用另外一个注解(@Transactional)方法时，注解失效
title: "spring同一个类中,一个方法调用另外一个注解(@Transactional)方法时,注解失效" url: "https://wsk1103.githu ...

Swagger 注解~用于方法

Swagger 注解~用于方法相关推荐

最新文章

热门文章