com.github.kongchen.swagger.docgen.reader

类 SpringMvcApiReader

java.lang.Object

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

com.github.kongchen.swagger.docgen.reader.SpringMvcApiReader

所有已实现的接口:

ClassSwaggerReader

public class SpringMvcApiReader
extends AbstractReader
implements ClassSwaggerReader

字段概要

从类继承的字段 com.github.kongchen.swagger.docgen.reader.AbstractReader

LOG, OPERATION_ID_FORMAT_DEFAULT, operationIdFormat, swagger

构造器概要

构造器

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

方法概要

限定符和类型	方法和说明
protected java.util.Map<java.lang.String,SpringResource>	generateResourceMap(java.util.Set<java.lang.Class<?>> validClasses)
io.swagger.models.Swagger	read(java.util.Set<java.lang.Class<?>> classes)
io.swagger.models.Swagger	read(SpringResource resource)
protected void	updateExtensionChain() Method which allows sub-classes to modify the Swagger extension chain.

从类继承的方法 com.github.kongchen.swagger.docgen.reader.AbstractReader

addTypeToSkippedTypes, canReadApi, extractTags, extractTypes, getOperationId, getOperationIdFormat, getParameters, getParameters, getSecurityRequirements, getTypesToSkip, isPrimitive, parseOperationPath, parseResponseHeaders, readImplicitParam, readImplicitParameters, setOperationIdFormat, setTypesToSkip, setTypesToSkip, updateApiResponse, updateOperation, updateOperationConsumes, updateOperationParameters, updateOperationProduces, updateOperationProtocols, updatePath, updateTagsForApi, updateTagsForOperation

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

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

构造器详细资料

SpringMvcApiReader

public SpringMvcApiReader(io.swagger.models.Swagger swagger,
                          org.apache.maven.plugin.logging.Log log)

方法详细资料

updateExtensionChain

protected void updateExtensionChain()

从类复制的说明: AbstractReader

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

覆盖:

updateExtensionChain 在类中 AbstractReader

read

public io.swagger.models.Swagger read(java.util.Set<java.lang.Class<?>> classes)
                               throws GenerateException

指定者:

read 在接口中 ClassSwaggerReader

抛出:

GenerateException

read

public io.swagger.models.Swagger read(SpringResource resource)

generateResourceMap

protected java.util.Map<java.lang.String,SpringResource> generateResourceMap(java.util.Set<java.lang.Class<?>> validClasses)
                                                                      throws GenerateException

抛出:

GenerateException