com.github.kongchen.swagger.docgen.reader

类 AbstractReader

java.lang.Object

com.github.kongchen.swagger.docgen.reader.AbstractReader

直接已知子类:

JaxrsReader, ServletReader, SpringMvcApiReader, SwaggerReader

public abstract class AbstractReader
extends java.lang.Object

作者:

chekong on 15/4/28.

字段概要

字段

限定符和类型	字段和说明
protected org.apache.maven.plugin.logging.Log	LOG
static java.lang.String	OPERATION_ID_FORMAT_DEFAULT Supported parameters: {{packageName}}, {{className}}, {{methodName}}, {{httpMethod}} Suggested default value is: "{{className}}_{{methodName}}_{{httpMethod}}"
protected java.lang.String	operationIdFormat
protected io.swagger.models.Swagger	swagger

构造器概要

构造器

构造器和说明
AbstractReader(io.swagger.models.Swagger swagger, org.apache.maven.plugin.logging.Log LOG)

方法概要

限定符和类型	方法和说明
void	addTypeToSkippedTypes(java.lang.reflect.Type type)
protected boolean	canReadApi(boolean readHidden, io.swagger.annotations.Api api)
protected java.util.Set<io.swagger.models.Tag>	extractTags(io.swagger.annotations.Api api)
java.util.List<io.swagger.models.parameters.Parameter>	extractTypes(java.lang.Class<?> cls, java.util.Set<java.lang.reflect.Type> typesToSkip, java.util.List<java.lang.annotation.Annotation> additionalAnnotations)
protected java.lang.String	getOperationId(java.lang.reflect.Method method, java.lang.String httpMethod)
java.lang.String	getOperationIdFormat()
protected java.util.List<io.swagger.models.parameters.Parameter>	getParameters(java.lang.reflect.Type type, java.util.List<java.lang.annotation.Annotation> annotations)
protected java.util.List<io.swagger.models.parameters.Parameter>	getParameters(java.lang.reflect.Type type, java.util.List<java.lang.annotation.Annotation> annotations, java.util.Set<java.lang.reflect.Type> typesToSkip)
protected java.util.List<io.swagger.models.SecurityRequirement>	getSecurityRequirements(io.swagger.annotations.Api api)
java.util.Set<java.lang.reflect.Type>	getTypesToSkip()
protected boolean	isPrimitive(java.lang.reflect.Type cls)
protected java.lang.String	parseOperationPath(java.lang.String operationPath, java.util.Map<java.lang.String,java.lang.String> regexMap)
protected java.util.Map<java.lang.String,io.swagger.models.properties.Property>	parseResponseHeaders(io.swagger.annotations.ResponseHeader[] headers)
protected io.swagger.models.parameters.Parameter	readImplicitParam(io.swagger.annotations.ApiImplicitParam param, java.lang.Class<?> apiClass)
protected void	readImplicitParameters(java.lang.reflect.Method method, io.swagger.models.Operation operation)
void	setOperationIdFormat(java.lang.String operationIdFormat)
void	setTypesToSkip(java.util.List<java.lang.reflect.Type> typesToSkip)
void	setTypesToSkip(java.util.Set<java.lang.reflect.Type> typesToSkip)
protected void	updateApiResponse(io.swagger.models.Operation operation, io.swagger.annotations.ApiResponses responseAnnotation)
protected void	updateExtensionChain() Method which allows sub-classes to modify the Swagger extension chain.
protected void	updateOperation(java.lang.String[] apiConsumes, java.lang.String[] apiProduces, java.util.Map<java.lang.String,io.swagger.models.Tag> tags, java.util.List<io.swagger.models.SecurityRequirement> securities, io.swagger.models.Operation operation)
protected java.lang.String[]	updateOperationConsumes(java.lang.String[] parentConsumes, java.lang.String[] apiConsumes, io.swagger.models.Operation operation)
protected void	updateOperationParameters(java.util.List<io.swagger.models.parameters.Parameter> parentParameters, java.util.Map<java.lang.String,java.lang.String> regexMap, io.swagger.models.Operation operation)
protected java.lang.String[]	updateOperationProduces(java.lang.String[] parentProduces, java.lang.String[] apiProduces, io.swagger.models.Operation operation)
protected void	updateOperationProtocols(io.swagger.annotations.ApiOperation apiOperation, io.swagger.models.Operation operation)
protected void	updatePath(java.lang.String operationPath, java.lang.String httpMethod, io.swagger.models.Operation operation)
protected java.util.Map<java.lang.String,io.swagger.models.Tag>	updateTagsForApi(java.util.Map<java.lang.String,io.swagger.models.Tag> parentTags, io.swagger.annotations.Api api)
protected void	updateTagsForOperation(io.swagger.models.Operation operation, io.swagger.annotations.ApiOperation apiOperation)

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

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

字段详细资料

LOG

protected final org.apache.maven.plugin.logging.Log LOG

swagger

protected io.swagger.models.Swagger swagger

operationIdFormat

protected java.lang.String operationIdFormat

OPERATION_ID_FORMAT_DEFAULT

public static final java.lang.String OPERATION_ID_FORMAT_DEFAULT

Supported parameters: {{packageName}}, {{className}}, {{methodName}}, {{httpMethod}} Suggested default value is: "{{className}}_{{methodName}}_{{httpMethod}}"

另请参阅:

常量字段值

构造器详细资料

AbstractReader

public AbstractReader(io.swagger.models.Swagger swagger,
                      org.apache.maven.plugin.logging.Log LOG)

方法详细资料

getTypesToSkip

public java.util.Set<java.lang.reflect.Type> getTypesToSkip()

setTypesToSkip

public void setTypesToSkip(java.util.List<java.lang.reflect.Type> typesToSkip)

setTypesToSkip

public void setTypesToSkip(java.util.Set<java.lang.reflect.Type> typesToSkip)

addTypeToSkippedTypes

public void addTypeToSkippedTypes(java.lang.reflect.Type type)

updateExtensionChain

protected void updateExtensionChain()

Method which allows sub-classes to modify the Swagger extension chain.

getSecurityRequirements

protected java.util.List<io.swagger.models.SecurityRequirement> getSecurityRequirements(io.swagger.annotations.Api api)

parseOperationPath

protected java.lang.String parseOperationPath(java.lang.String operationPath,
                                              java.util.Map<java.lang.String,java.lang.String> regexMap)

updateOperationParameters

protected void updateOperationParameters(java.util.List<io.swagger.models.parameters.Parameter> parentParameters,
                                         java.util.Map<java.lang.String,java.lang.String> regexMap,
                                         io.swagger.models.Operation operation)

parseResponseHeaders

protected java.util.Map<java.lang.String,io.swagger.models.properties.Property> parseResponseHeaders(io.swagger.annotations.ResponseHeader[] headers)

updatePath

protected void updatePath(java.lang.String operationPath,
                          java.lang.String httpMethod,
                          io.swagger.models.Operation operation)

updateTagsForOperation

protected void updateTagsForOperation(io.swagger.models.Operation operation,
                                      io.swagger.annotations.ApiOperation apiOperation)

canReadApi

protected boolean canReadApi(boolean readHidden,
                             io.swagger.annotations.Api api)

extractTags

protected java.util.Set<io.swagger.models.Tag> extractTags(io.swagger.annotations.Api api)

updateOperationProtocols

protected void updateOperationProtocols(io.swagger.annotations.ApiOperation apiOperation,
                                        io.swagger.models.Operation operation)

updateTagsForApi

protected java.util.Map<java.lang.String,io.swagger.models.Tag> updateTagsForApi(java.util.Map<java.lang.String,io.swagger.models.Tag> parentTags,
                                                                                 io.swagger.annotations.Api api)

isPrimitive

protected boolean isPrimitive(java.lang.reflect.Type cls)

updateOperation

protected void updateOperation(java.lang.String[] apiConsumes,
                               java.lang.String[] apiProduces,
                               java.util.Map<java.lang.String,io.swagger.models.Tag> tags,
                               java.util.List<io.swagger.models.SecurityRequirement> securities,
                               io.swagger.models.Operation operation)

getParameters

protected final java.util.List<io.swagger.models.parameters.Parameter> getParameters(java.lang.reflect.Type type,
                                                                                     java.util.List<java.lang.annotation.Annotation> annotations)

getParameters

protected java.util.List<io.swagger.models.parameters.Parameter> getParameters(java.lang.reflect.Type type,
                                                                               java.util.List<java.lang.annotation.Annotation> annotations,
                                                                               java.util.Set<java.lang.reflect.Type> typesToSkip)

updateApiResponse

protected void updateApiResponse(io.swagger.models.Operation operation,
                                 io.swagger.annotations.ApiResponses responseAnnotation)

updateOperationProduces

protected java.lang.String[] updateOperationProduces(java.lang.String[] parentProduces,
                                                     java.lang.String[] apiProduces,
                                                     io.swagger.models.Operation operation)

updateOperationConsumes

protected java.lang.String[] updateOperationConsumes(java.lang.String[] parentConsumes,
                                                     java.lang.String[] apiConsumes,
                                                     io.swagger.models.Operation operation)

readImplicitParameters

protected void readImplicitParameters(java.lang.reflect.Method method,
                                      io.swagger.models.Operation operation)

readImplicitParam

protected io.swagger.models.parameters.Parameter readImplicitParam(io.swagger.annotations.ApiImplicitParam param,
                                                                   java.lang.Class<?> apiClass)

getOperationId

protected java.lang.String getOperationId(java.lang.reflect.Method method,
                                          java.lang.String httpMethod)

extractTypes

public java.util.List<io.swagger.models.parameters.Parameter> extractTypes(java.lang.Class<?> cls,
                                                                           java.util.Set<java.lang.reflect.Type> typesToSkip,
                                                                           java.util.List<java.lang.annotation.Annotation> additionalAnnotations)

getOperationIdFormat

public java.lang.String getOperationIdFormat()

setOperationIdFormat

public void setOperationIdFormat(java.lang.String operationIdFormat)