Swagger注解-@ApiOperation

使用场景

在 Rest 接口上使用

概述

描述针对特定路径的操作,通常是 HTTP 方法。具有等效路径的操作被分到单个分组中。HTTP 方法和路径的组合创建了一个独特的操作

属性

属性名称 数据类型 默认值 说明
value String 接口简要说明,120字符或更少
notes String “” 接口详细描述
tags String[] “” tag 列表,可用于按自愿或任何其它限定符对操作进行逻辑分组
response Class Void.class 接口返回类型
responseContainer String “” 声明包装响应的容器。有效值为 List,Set,Map,任何其它值都将被忽略
responseReference String “” 指定对响应类型的引用,本地/远程引用,并将覆盖任何其它指定的response()类
httpMethod String “” 请求方式:“GET”, “HEAD”, “POST”, “PUT”, “DELETE”, “OPTIONS” and “PATCH”,如果未指定则使用除"PATH"之外的其它所有
nickname String “” 第三方工具使用operationId来唯一表示此操作
produces String “” 采用逗号分隔的 content types 类型的返回数据,例如:application/json,application/xml
consumes String “” 采用逗号分隔的 content types 类型的入参数据类型,例如:application/json,application/xml
protocols String “” 指定协议类型:http,https,ws,wss,多个协议使用逗号进行分隔
authorizations Authorization[] @Authorization(value = “”) 获取此操作的授权列表
hidden boolean false 是否隐藏操作列表中的操作
responseHeaders ResponseHeader[] @ResponseHeader(name = “”, response = Void.class) 指定 response header 信息列表
code int 200 HTTP返回状态码
extensions Extension[] @Extension(properties = @ExtensionProperty(name = “”, value = “”)) 可选的扩展数组

你可能感兴趣的:(swagger注解,Swagger)