swagger @ApiOperation 注释


@ApiOperation

  • value = “接口说明"

    提供该操作的简要描述。在Swagger-UI中,应该是120个字符或更少。

  • httpMethod = “对应于使用的HTTP方法的’ method '字段。”

page:
在这里插入图片描述code:

@ApiOperation(value ="Used to read user information",
				notes ="API for used to read user information" ,
				httpMethod ="GET",
				tags = "dfa")
    public String getUserInfo() {}

如果没有声明,在JAX-RS应用程序中,将扫描并使用以下JAX-RS注释:@GET、@HEAD、@POST、@PUT、@DELETE和@OPTIONS。注意,即使不是JAX-RS规范的一部分,如果您创建并使用@PATCH注释,它也将被解析和使用。如果设置了httpMethod属性,它将覆盖JAX-RS注释。

对于servlet,必须手动指定HTTP方法。

可接受的值为GET、HEAD、POST、PUT、DELETE、OPTIONS和PATCH。

  • notes = “对应于操作的’notes’字段”

    对应于操作的’notes’字段,对操作的详细描述。

  • response = “接口返回参数类型”

    在JAX-RS应用程序中,方法的返回类型将被自动使用,除非它是javax.ws.rs.core.Response。在这种情况下,操作返回类型将默认为’ void ',因为实际的响应类型无法知道,设置此属性将覆盖任何自动派生的数据类型,如果使用的值是一个表示基元(Integer, Long,…)的类,则使用相应的基元类型。

  • tags = “用于API文档控制的标签列表。”

    标签可以用于按资源或任何其他限定符对操作进行逻辑分组。非空值将覆盖从Api.value()或Api.tags()接收到的此操作的值。
    page:
    在这里插入图片描述

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值