ApiOperation (Jboot)

java.lang.Object
- io.jboot.apidoc.ApiOperation

所有已实现的接口:: Serializable

public class ApiOperation
extends Object
implements Serializable

另请参阅:: 序列化表格

字段概要

字段
限定符和类型	字段和说明
`private String`	`actionKey`
`private List<ApiParameter>`	`apiParameters`
`private ContentType`	`contentType`
`private Class<?>`	`controllerClass`
`private Method`	`method`
`private String`	`notes`
`private int`	`orderNo`
`private String`	`paraNotes`
`private String`	`retMockJson`
`private Map<String,List<ApiResponse>>`	`retRemarks`
`private ClassType`	`retType`
`private String`	`value`

构造器概要

构造器
构造器和说明

ApiOperation()

构造器
构造器和说明
`ApiOperation()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addApiParameter(ApiParameter parameter)`
`String`	`getActionKey()`
`List<ApiParameter>`	`getApiParameters()`
`ContentType`	`getContentType()`
`Class<?>`	`getControllerClass()`
`Method`	`getMethod()`
`String`	`getNotes()`
`int`	`getOrderNo()`
`String`	`getParaNotes()`
`String`	`getRetMockJson()`
`Map<String,List<ApiResponse>>`	`getRetRemarks()`
`ClassType`	`getRetType()`
`String`	`getValue()`
`boolean`	`hasParameter()`
`void`	`setActionKey(String actionKey)`
`void`	`setApiParameters(List<ApiParameter> apiParameters)`
`void`	`setContentType(ContentType contentType)`
`void`	`setControllerClass(Class<?> controllerClass)`
`void`	`setMethod(Method method)`
`void`	`setMethodAndInfo(Method method, String controllerPath, HttpMethod[] defaultMethods, Class<?> containerClass)`
`void`	`setNotes(String notes)`
`void`	`setOrderNo(int orderNo)`
`private void`	`setParameters(Method method, HttpMethod[] defaultMethods)`
`void`	`setParaNotes(String paraNotes)`
`void`	`setRetMockJson(String retMockJson)`
`void`	`setRetRemarks(Map<String,List<ApiResponse>> retRemarks)`
`void`	`setRetType(ClassType retType)`
`void`	`setValue(String value)`
`String`	`toString()`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

字段详细资料

value
```
private String value
```

notes
```
private String notes
```

paraNotes
```
private String paraNotes
```

orderNo
```
private int orderNo
```

actionKey
```
private String actionKey
```

contentType
```
private ContentType contentType
```

apiParameters

private List<ApiParameter> apiParameters

retType
```
private ClassType retType
```

retMockJson
```
private String retMockJson
```

retRemarks

private Map<String,List<ApiResponse>> retRemarks

controllerClass
```
private Class<?> controllerClass
```

method
```
private Method method
```

构造器详细资料
- ApiOperation
```
public ApiOperation()
```

方法详细资料

getValue
```
public String getValue()
```

setValue
```
public void setValue(String value)
```

getNotes
```
public String getNotes()
```

setNotes
```
public void setNotes(String notes)
```

getParaNotes
```
public String getParaNotes()
```

setParaNotes

public void setParaNotes(String paraNotes)

getOrderNo
```
public int getOrderNo()
```

setOrderNo
```
public void setOrderNo(int orderNo)
```

getActionKey
```
public String getActionKey()
```

setActionKey

public void setActionKey(String actionKey)

getContentType
```
public ContentType getContentType()
```

setContentType

public void setContentType(ContentType contentType)

getApiParameters

public List<ApiParameter> getApiParameters()

setApiParameters

public void setApiParameters(List<ApiParameter> apiParameters)

addApiParameter

public void addApiParameter(ApiParameter parameter)

hasParameter
```
public boolean hasParameter()
```

getRetType
```
public ClassType getRetType()
```

setRetType

public void setRetType(ClassType retType)

getMethod
```
public Method getMethod()
```

setMethod
```
public void setMethod(Method method)
```

getControllerClass
```
public Class<?> getControllerClass()
```

setControllerClass

public void setControllerClass(Class<?> controllerClass)

setMethodAndInfo

public void setMethodAndInfo(Method method,
                             String controllerPath,
                             HttpMethod[] defaultMethods,
                             Class<?> containerClass)

setParameters

private void setParameters(Method method,
                           HttpMethod[] defaultMethods)

getRetMockJson
```
public String getRetMockJson()
```

setRetMockJson

public void setRetMockJson(String retMockJson)

getRetRemarks

public Map<String,List<ApiResponse>> getRetRemarks()

setRetRemarks

public void setRetRemarks(Map<String,List<ApiResponse>> retRemarks)

toString
```
public String toString()
```
覆盖:

toString 在类中 Object

类 ApiOperation

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

value

notes

paraNotes

orderNo

actionKey

contentType

apiParameters

retType

retMockJson

retRemarks

controllerClass

method

构造器详细资料

ApiOperation

方法详细资料

getValue

setValue

getNotes

setNotes

getParaNotes

setParaNotes

getOrderNo

setOrderNo

getActionKey

setActionKey

getContentType

setContentType

getApiParameters

setApiParameters

addApiParameter

hasParameter

getRetType

setRetType

getMethod

setMethod

getControllerClass

setControllerClass

setMethodAndInfo

setParameters

getRetMockJson

setRetMockJson

getRetRemarks

setRetRemarks

toString