程序包 springfox.documentation.spi.service.contexts

类 OperationContext

java.lang.Object

springfox.documentation.spi.service.contexts.OperationContext

public class OperationContext
extends Object

构造器概要

构造器

构造器	说明
OperationContext(OperationBuilder operationBuilder, org.springframework.web.bind.annotation.RequestMethod requestMethod, RequestMappingContext requestContext, int operationIndex)

方法概要

修饰符和类型	方法	说明
com.fasterxml.classmate.ResolvedType	alternateFor(com.fasterxml.classmate.ResolvedType resolved)
Set<? extends org.springframework.http.MediaType>	consumes()
<T extends Annotation> List<T>	findAllAnnotations(Class<T> annotation)
<T extends Annotation> com.google.common.base.Optional<T>	findAnnotation(Class<T> annotation)
<T extends Annotation> com.google.common.base.Optional<T>	findControllerAnnotation(Class<T> annotation)
AlternateTypeProvider	getAlternateTypeProvider()
DocumentationContext	getDocumentationContext()
DocumentationType	getDocumentationType()
GenericTypeNamingStrategy	getGenericsNamingStrategy()
List<Parameter>	getGlobalOperationParameters()
List<ResponseMessage>	getGlobalResponseMessages(String forHttpMethod)
String	getGroupName()
com.google.common.collect.ImmutableSet<Class>	getIgnorableParameterTypes()
String	getName()
List<ResolvedMethodParameter>	getParameters()
com.fasterxml.classmate.ResolvedType	getReturnType()
Set<org.springframework.web.servlet.mvc.condition.NameValueExpression<String>>	headers()
org.springframework.http.HttpMethod	httpMethod()
OperationBuilder	operationBuilder()
int	operationIndex()
Set<org.springframework.web.servlet.mvc.condition.NameValueExpression<String>>	params()
Set<? extends org.springframework.http.MediaType>	produces()
String	requestMappingPattern()
List<SecurityContext>	securityContext()

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

OperationContext

public OperationContext(OperationBuilder operationBuilder,
 org.springframework.web.bind.annotation.RequestMethod requestMethod,
 RequestMappingContext requestContext,
 int operationIndex)

方法详细资料

operationBuilder

public OperationBuilder operationBuilder()

httpMethod

public org.springframework.http.HttpMethod httpMethod()

operationIndex

public int operationIndex()

getGlobalResponseMessages

public List<ResponseMessage> getGlobalResponseMessages(String forHttpMethod)

getGlobalOperationParameters

public List<Parameter> getGlobalOperationParameters()

securityContext

public List<SecurityContext> securityContext()

requestMappingPattern

public String requestMappingPattern()

getDocumentationContext

public DocumentationContext getDocumentationContext()

getDocumentationType

public DocumentationType getDocumentationType()

getAlternateTypeProvider

public AlternateTypeProvider getAlternateTypeProvider()

alternateFor

public com.fasterxml.classmate.ResolvedType alternateFor(com.fasterxml.classmate.ResolvedType resolved)

produces

public Set<? extends org.springframework.http.MediaType> produces()

consumes

public Set<? extends org.springframework.http.MediaType> consumes()

getIgnorableParameterTypes

public com.google.common.collect.ImmutableSet<Class> getIgnorableParameterTypes()

getGenericsNamingStrategy

public GenericTypeNamingStrategy getGenericsNamingStrategy()

headers

public Set<org.springframework.web.servlet.mvc.condition.NameValueExpression<String>> headers()

params

public Set<org.springframework.web.servlet.mvc.condition.NameValueExpression<String>> params()

getName

public String getName()

getGroupName

public String getGroupName()

getParameters

public List<ResolvedMethodParameter> getParameters()

findAnnotation

public <T extends Annotation>
com.google.common.base.Optional<T> findAnnotation(Class<T> annotation)

getReturnType

public com.fasterxml.classmate.ResolvedType getReturnType()

findControllerAnnotation

public <T extends Annotation>
com.google.common.base.Optional<T> findControllerAnnotation(Class<T> annotation)

findAllAnnotations

public <T extends Annotation> List<T> findAllAnnotations(Class<T> annotation)