top.hequehua.swagger.annotation

注释类型 ApiOperation

@Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface ApiOperation

可选元素概要

可选元素

限定符和类型	可选元素和说明
String[]	consumes 请求数据格式
String	description 对api资源的描述
boolean	hidden 是否显示
RequestMethod[]	methods 请求类型
String[]	produces 返回数据格式
String	summary
String[]	tags 如果设置这个值、value的值不会被覆盖
String	value url的路径值,如为空则通过 Route进行自动获取url

元素详细资料

value

public abstract String value

url的路径值,如为空则通过 Route进行自动获取url

返回:

默认值:

""

tags

public abstract String[] tags

如果设置这个值、value的值不会被覆盖

返回:

默认值:

{}

methods

public abstract RequestMethod[] methods

请求类型

返回:

默认值:

{}

summary

public abstract String summary

默认值:

""

description

public abstract String description

对api资源的描述

返回:

默认值:

""

consumes

public abstract String[] consumes

请求数据格式

返回:

默认值:

"application/json"

produces

public abstract String[] produces

返回数据格式

返回:

默认值:

"application/json"

hidden

public abstract boolean hidden

是否显示

默认值:

false