com.github.kongchen.swagger.docgen.mavenplugin

类 ApiSource

java.lang.Object

com.github.kongchen.swagger.docgen.mavenplugin.ApiSource

public class ApiSource
extends java.lang.Object

User: kongchen Date: 3/7/13

构造器概要

构造器

构造器和说明
ApiSource()

方法概要

限定符和类型	方法和说明
java.util.List<java.lang.String>	getApiModelPropertyAccessExclusions()
java.lang.String	getApiSortComparator()
java.lang.String	getBasePath()
java.io.File	getDescriptionFile()
io.swagger.models.ExternalDocs	getExternalDocs()
java.lang.String	getHost()
io.swagger.models.Info	getInfo()
java.util.List<java.lang.String>	getLocations()
java.util.List<java.lang.String>	getModelConverters()
java.lang.String	getModelSubstitute()
java.lang.String	getOperationIdFormat()
java.lang.String	getOutputFormats()
java.lang.String	getOutputPath()
java.lang.Boolean	getRemoveBasePathFromEndpoints()
java.util.List<java.lang.String>	getSchemes()
java.util.List<SecurityDefinition>	getSecurityDefinitions()
java.lang.String	getSwaggerApiReader()
java.lang.String	getSwaggerDirectory()
java.util.List<java.lang.String>	getSwaggerExtensions()
java.lang.String	getSwaggerFileName()
java.lang.String	getSwaggerInternalFilter()
java.lang.String	getSwaggerSchemaConverter()
java.lang.String	getSwaggerUIDocBasePath()
java.lang.String	getTemplatePath()
java.util.List<java.lang.String>	getTypesToSkip()
java.util.Set<java.lang.Class<?>>	getValidClasses(java.lang.Class<? extends java.lang.annotation.Annotation> clazz)
boolean	isAttachSwaggerArtifact()
boolean	isJsonExampleValues()
boolean	isSpringmvc()
boolean	isUseJAXBAnnotationProcessor()
boolean	isUseJAXBAnnotationProcessorAsPrimary()
void	setApiModelPropertyExclusions(java.util.List<java.lang.String> apiModelPropertyAccessExclusions)
void	setApiSortComparator(java.lang.String apiSortComparator)
void	setAttachSwaggerArtifact(boolean attachSwaggerArtifact)
void	setBasePath(java.lang.String basePath)
void	setDescriptionFile(java.io.File descriptionFile)
void	setHost(java.lang.String host)
void	setInfo(io.swagger.models.Info info)
void	setJsonExampleValues(boolean jsonExampleValues)
void	setLocations(java.util.List<java.lang.String> locations)
void	setModelConverters(java.util.List<java.lang.String> modelConverters)
void	setModelSubstitute(java.lang.String modelSubstitute)
void	setOperationIdFormat(java.lang.String operationIdFormat)
void	setOutputFormats(java.lang.String outputFormats)
void	setOutputPath(java.lang.String outputPath)
void	setRemoveBasePathFromEndpoints(java.lang.Boolean removeBasePathFromEndpoints)
void	setSchemes(java.util.List<java.lang.String> schemes)
void	setSecurityDefinitions(java.util.List<SecurityDefinition> securityDefinitions)
void	setSpringmvc(boolean springmvc)
void	setSwaggerApiReader(java.lang.String swaggerApiReader)
void	setSwaggerDirectory(java.lang.String swaggerDirectory)
void	setSwaggerExtensions(java.util.List<java.lang.String> swaggerExtensions)
void	setSwaggerFileName(java.lang.String swaggerFileName)
void	setSwaggerInternalFilter(java.lang.String swaggerInternalFilter)
void	setSwaggerSchemaConverter(java.lang.String swaggerSchemaConverter)
void	setSwaggerUIDocBasePath(java.lang.String swaggerUIDocBasePath)
void	setTemplatePath(java.lang.String templatePath)
void	setTypesToSkip(java.util.List<java.lang.String> typesToSkip)
void	setUseJAXBAnnotationProcessor(boolean useJAXBAnnotationProcessor)
void	setUseJAXBAnnotationProcessorAsPrimary(boolean useJAXBAnnotationProcessorAsPrimary)

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

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

构造器详细资料

ApiSource

public ApiSource()

方法详细资料

getValidClasses

public java.util.Set<java.lang.Class<?>> getValidClasses(java.lang.Class<? extends java.lang.annotation.Annotation> clazz)

getApiModelPropertyAccessExclusions

public java.util.List<java.lang.String> getApiModelPropertyAccessExclusions()

setApiModelPropertyExclusions

public void setApiModelPropertyExclusions(java.util.List<java.lang.String> apiModelPropertyAccessExclusions)

getSecurityDefinitions

public java.util.List<SecurityDefinition> getSecurityDefinitions()

getTypesToSkip

public java.util.List<java.lang.String> getTypesToSkip()

setTypesToSkip

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

setSecurityDefinitions

public void setSecurityDefinitions(java.util.List<SecurityDefinition> securityDefinitions)

getInfo

public io.swagger.models.Info getInfo()

setInfo

public void setInfo(io.swagger.models.Info info)

getLocations

public java.util.List<java.lang.String> getLocations()

setLocations

public void setLocations(java.util.List<java.lang.String> locations)

getTemplatePath

public java.lang.String getTemplatePath()

setTemplatePath

public void setTemplatePath(java.lang.String templatePath)

getOutputPath

public java.lang.String getOutputPath()

setOutputPath

public void setOutputPath(java.lang.String outputPath)

getOutputFormats

public java.lang.String getOutputFormats()

setOutputFormats

public void setOutputFormats(java.lang.String outputFormats)

getBasePath

public java.lang.String getBasePath()

setBasePath

public void setBasePath(java.lang.String basePath)

getSwaggerDirectory

public java.lang.String getSwaggerDirectory()

setSwaggerDirectory

public void setSwaggerDirectory(java.lang.String swaggerDirectory)

getSwaggerFileName

public java.lang.String getSwaggerFileName()

setSwaggerFileName

public void setSwaggerFileName(java.lang.String swaggerFileName)

isAttachSwaggerArtifact

public boolean isAttachSwaggerArtifact()

setAttachSwaggerArtifact

public void setAttachSwaggerArtifact(boolean attachSwaggerArtifact)

setSwaggerUIDocBasePath

public void setSwaggerUIDocBasePath(java.lang.String swaggerUIDocBasePath)

getSwaggerUIDocBasePath

public java.lang.String getSwaggerUIDocBasePath()

getHost

public java.lang.String getHost()

getExternalDocs

public io.swagger.models.ExternalDocs getExternalDocs()

setModelSubstitute

public void setModelSubstitute(java.lang.String modelSubstitute)

getSwaggerInternalFilter

public java.lang.String getSwaggerInternalFilter()

setSwaggerInternalFilter

public void setSwaggerInternalFilter(java.lang.String swaggerInternalFilter)

getSwaggerApiReader

public java.lang.String getSwaggerApiReader()

setSwaggerApiReader

public void setSwaggerApiReader(java.lang.String swaggerApiReader)

getSwaggerExtensions

public java.util.List<java.lang.String> getSwaggerExtensions()

setSwaggerExtensions

public void setSwaggerExtensions(java.util.List<java.lang.String> swaggerExtensions)

getApiSortComparator

public java.lang.String getApiSortComparator()

setApiSortComparator

public void setApiSortComparator(java.lang.String apiSortComparator)

setHost

public void setHost(java.lang.String host)

getSchemes

public java.util.List<java.lang.String> getSchemes()

setSchemes

public void setSchemes(java.util.List<java.lang.String> schemes)

getModelSubstitute

public java.lang.String getModelSubstitute()

isSpringmvc

public boolean isSpringmvc()

setSpringmvc

public void setSpringmvc(boolean springmvc)

getSwaggerSchemaConverter

public java.lang.String getSwaggerSchemaConverter()

setSwaggerSchemaConverter

public void setSwaggerSchemaConverter(java.lang.String swaggerSchemaConverter)

isJsonExampleValues

public boolean isJsonExampleValues()

setJsonExampleValues

public void setJsonExampleValues(boolean jsonExampleValues)

isUseJAXBAnnotationProcessor

public boolean isUseJAXBAnnotationProcessor()

setUseJAXBAnnotationProcessor

public void setUseJAXBAnnotationProcessor(boolean useJAXBAnnotationProcessor)

isUseJAXBAnnotationProcessorAsPrimary

public boolean isUseJAXBAnnotationProcessorAsPrimary()

setUseJAXBAnnotationProcessorAsPrimary

public void setUseJAXBAnnotationProcessorAsPrimary(boolean useJAXBAnnotationProcessorAsPrimary)

getDescriptionFile

public java.io.File getDescriptionFile()

setDescriptionFile

public void setDescriptionFile(java.io.File descriptionFile)

getModelConverters

public java.util.List<java.lang.String> getModelConverters()

setModelConverters

public void setModelConverters(java.util.List<java.lang.String> modelConverters)

getOperationIdFormat

public java.lang.String getOperationIdFormat()

setOperationIdFormat

public void setOperationIdFormat(java.lang.String operationIdFormat)

getRemoveBasePathFromEndpoints

public java.lang.Boolean getRemoveBasePathFromEndpoints()

setRemoveBasePathFromEndpoints

public void setRemoveBasePathFromEndpoints(java.lang.Boolean removeBasePathFromEndpoints)