com.github.kongchen.swagger.docgen.reader

类 SwaggerReader

java.lang.Object

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

com.github.kongchen.swagger.docgen.reader.SwaggerReader

所有已实现的接口:

ClassSwaggerReader

public class SwaggerReader
extends AbstractReader
implements ClassSwaggerReader

This API reader is directly using the swagger internal Reader to scan the classes. This reader is used when the exact output as the runtime generated swagger file is necessary.

字段概要

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

LOG, OPERATION_ID_FORMAT_DEFAULT, operationIdFormat, swagger

构造器概要

构造器

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

方法概要

限定符和类型	方法和说明
io.swagger.models.Swagger	read(java.util.Set<java.lang.Class<?>> classes)

从类继承的方法 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, updateExtensionChain, updateOperation, updateOperationConsumes, updateOperationParameters, updateOperationProduces, updateOperationProtocols, updatePath, updateTagsForApi, updateTagsForOperation

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

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

构造器详细资料

SwaggerReader

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

方法详细资料

read

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

指定者:

read 在接口中 ClassSwaggerReader

抛出:

GenerateException