com.github.kongchen.swagger.docgen

类 AbstractDocumentSource

java.lang.Object

com.github.kongchen.swagger.docgen.AbstractDocumentSource

直接已知子类:

MavenDocumentSource, SpringMavenDocumentSource

public abstract class AbstractDocumentSource
extends java.lang.Object

作者:

chekong 05/13/2013

字段概要

字段

限定符和类型	字段和说明
protected ApiSource	apiSource
protected java.lang.String	encoding
protected org.apache.maven.plugin.logging.Log	LOG
protected io.swagger.models.Swagger	swagger
protected java.lang.String	swaggerSchemaConverter
protected java.util.List<java.lang.reflect.Type>	typesToSkip

构造器概要

构造器

构造器和说明
AbstractDocumentSource(org.apache.maven.plugin.logging.Log log, ApiSource apiSource)

方法概要

限定符和类型	方法和说明
protected java.io.File	createFile(java.io.File dir, java.lang.String outputResourcePath)
protected ClassSwaggerReader	getCustomApiReader(java.lang.String customReaderClassName)
protected java.util.Set<java.lang.Class<?>>	getValidClasses() Returns the set of classes which should be included in the scanning.
void	loadDocuments()
void	loadModelConverters()
void	loadModelModifier()
void	loadTypesToSkip()
protected io.swagger.models.Swagger	removeBasePathFromEndpoints(io.swagger.models.Swagger swagger, boolean removeBasePathFromEndpoints)
protected abstract ClassSwaggerReader	resolveApiReader() Resolves the API reader which should be used to scan the classes.
protected java.util.List<io.swagger.jaxrs.ext.SwaggerExtension>	resolveSwaggerExtensions() Resolves all SwaggerExtension instances configured to be added to the Swagger configuration.
void	toDocuments()
void	toSwaggerDocuments(java.lang.String uiDocBasePath, java.lang.String outputFormats, java.lang.String encoding)
void	toSwaggerDocuments(java.lang.String uiDocBasePath, java.lang.String outputFormats, java.lang.String fileName, java.lang.String encoding)

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

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

字段详细资料

apiSource

protected final ApiSource apiSource

LOG

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

typesToSkip

protected final java.util.List<java.lang.reflect.Type> typesToSkip

swagger

protected io.swagger.models.Swagger swagger

swaggerSchemaConverter

protected java.lang.String swaggerSchemaConverter

encoding

protected java.lang.String encoding

构造器详细资料

AbstractDocumentSource

public AbstractDocumentSource(org.apache.maven.plugin.logging.Log log,
                              ApiSource apiSource)
                       throws org.apache.maven.plugin.MojoFailureException

抛出:

org.apache.maven.plugin.MojoFailureException

方法详细资料

loadDocuments

public void loadDocuments()
                   throws GenerateException

抛出:

GenerateException

toSwaggerDocuments

public void toSwaggerDocuments(java.lang.String uiDocBasePath,
                               java.lang.String outputFormats,
                               java.lang.String encoding)
                        throws GenerateException

抛出:

GenerateException

toSwaggerDocuments

public void toSwaggerDocuments(java.lang.String uiDocBasePath,
                               java.lang.String outputFormats,
                               java.lang.String fileName,
                               java.lang.String encoding)
                        throws GenerateException

抛出:

GenerateException

loadModelModifier

public void loadModelModifier()
                       throws GenerateException,
                              java.io.IOException

抛出:

GenerateException

java.io.IOException

loadModelConverters

public void loadModelConverters()
                         throws org.apache.maven.plugin.MojoExecutionException

抛出:

org.apache.maven.plugin.MojoExecutionException

loadTypesToSkip

public void loadTypesToSkip()
                     throws GenerateException

抛出:

GenerateException

removeBasePathFromEndpoints

protected io.swagger.models.Swagger removeBasePathFromEndpoints(io.swagger.models.Swagger swagger,
                                                                boolean removeBasePathFromEndpoints)

createFile

protected java.io.File createFile(java.io.File dir,
                                  java.lang.String outputResourcePath)
                           throws java.io.IOException

抛出:

java.io.IOException

toDocuments

public void toDocuments()
                 throws GenerateException

抛出:

GenerateException

resolveApiReader

protected abstract ClassSwaggerReader resolveApiReader()
                                                throws GenerateException

Resolves the API reader which should be used to scan the classes.

返回:

ClassSwaggerReader to use

抛出:

GenerateException - if the reader cannot be created / resolved

getValidClasses

protected java.util.Set<java.lang.Class<?>> getValidClasses()

Returns the set of classes which should be included in the scanning.

返回:

Set containing all valid classes

resolveSwaggerExtensions

protected java.util.List<io.swagger.jaxrs.ext.SwaggerExtension> resolveSwaggerExtensions()
                                                                                  throws GenerateException

Resolves all SwaggerExtension instances configured to be added to the Swagger configuration.

返回:

List of SwaggerExtension which should be added to the swagger configuration

抛出:

GenerateException - if the swagger extensions could not be created / resolved

getCustomApiReader

protected ClassSwaggerReader getCustomApiReader(java.lang.String customReaderClassName)
                                         throws GenerateException

抛出:

GenerateException