@ApiOperation
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: