com.github.kongchen.swagger.docgen.reader

类 JaxrsReader

java.lang.Object

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

com.github.kongchen.swagger.docgen.reader.JaxrsReader

所有已实现的接口:

ClassSwaggerReader

public class JaxrsReader
extends AbstractReader
implements ClassSwaggerReader

字段概要

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

LOG, OPERATION_ID_FORMAT_DEFAULT, operationIdFormat, swagger

构造器概要

构造器

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

方法概要

限定符和类型	方法和说明
java.lang.String	extractOperationMethod(io.swagger.annotations.ApiOperation apiOperation, java.lang.reflect.Method method, java.util.Iterator<io.swagger.jaxrs.ext.SwaggerExtension> chain)
static java.lang.annotation.Annotation[][]	findParamAnnotations(java.lang.reflect.Method method)
io.swagger.models.Swagger	getSwagger()
protected boolean	isSubResource(java.lang.String httpMethod, java.lang.reflect.Method method)
io.swagger.models.Operation	parseMethod(java.lang.String httpMethod, java.lang.reflect.Method method)
io.swagger.models.Swagger	read(java.lang.Class<?> cls)
protected io.swagger.models.Swagger	read(java.lang.Class<?> cls, java.lang.String parentPath, java.lang.String parentMethod, boolean readHidden, java.lang.String[] parentConsumes, java.lang.String[] parentProduces, java.util.Map<java.lang.String,io.swagger.models.Tag> parentTags, java.util.List<io.swagger.models.parameters.Parameter> parentParameters)
io.swagger.models.Swagger	read(java.util.Set<java.lang.Class<?>> classes)
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

构造器详细资料

JaxrsReader

public JaxrsReader(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)

指定者:

read 在接口中 ClassSwaggerReader

getSwagger

public io.swagger.models.Swagger getSwagger()

read

public io.swagger.models.Swagger read(java.lang.Class<?> cls)

read

protected io.swagger.models.Swagger read(java.lang.Class<?> cls,
                                         java.lang.String parentPath,
                                         java.lang.String parentMethod,
                                         boolean readHidden,
                                         java.lang.String[] parentConsumes,
                                         java.lang.String[] parentProduces,
                                         java.util.Map<java.lang.String,io.swagger.models.Tag> parentTags,
                                         java.util.List<io.swagger.models.parameters.Parameter> parentParameters)

isSubResource

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

parseMethod

public io.swagger.models.Operation parseMethod(java.lang.String httpMethod,
                                               java.lang.reflect.Method method)

findParamAnnotations

public static java.lang.annotation.Annotation[][] findParamAnnotations(java.lang.reflect.Method method)

extractOperationMethod

public java.lang.String extractOperationMethod(io.swagger.annotations.ApiOperation apiOperation,
                                               java.lang.reflect.Method method,
                                               java.util.Iterator<io.swagger.jaxrs.ext.SwaggerExtension> chain)