ai.houyi.dorado.swagger

类 Reader

java.lang.Object

ai.houyi.dorado.swagger.Reader

public class Reader
extends Object

构造器概要

构造器

构造器和说明
Reader(io.swagger.models.Swagger swagger)

方法概要

限定符和类型	方法和说明
String	extractOperationMethod(io.swagger.annotations.ApiOperation apiOperation, Method method, Iterator<SwaggerExtension> chain)
protected Set<String>	extractTags(io.swagger.annotations.Api api)
protected String	getOperationId(String operationId)
protected Class<?>	getSubResource(Method method)
io.swagger.models.Swagger	getSwagger()
io.swagger.models.Operation	parseMethod(Method method)
io.swagger.models.Swagger	read(Class<?> cls) Scans a single class for Swagger annotations - does not invoke ReaderListeners
protected io.swagger.models.Swagger	read(Class<?> cls, Map<String,io.swagger.models.Tag> parentTags, List<io.swagger.models.parameters.Parameter> parentParameters)
io.swagger.models.Swagger	read(Set<Class<?>> classes) Scans a set of classes for both ReaderListeners and Swagger annotations.
protected io.swagger.models.parameters.Parameter	readImplicitParam(io.swagger.annotations.ApiImplicitParam param)
protected void	readInfoConfig(io.swagger.annotations.SwaggerDefinition config)
protected void	readSwaggerConfig(Class<?> cls, io.swagger.annotations.SwaggerDefinition config)

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

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

构造器详细资料

Reader

public Reader(io.swagger.models.Swagger swagger)

方法详细资料

getSwagger

public io.swagger.models.Swagger getSwagger()

read

public io.swagger.models.Swagger read(Set<Class<?>> classes)

Scans a set of classes for both ReaderListeners and Swagger annotations. All found listeners will be instantiated before any of the classes are scanned for Swagger annotations - so they can be invoked accordingly.

参数:

classes - a set of classes to scan

返回:

the generated Swagger definition

read

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

Scans a single class for Swagger annotations - does not invoke ReaderListeners

read

protected io.swagger.models.Swagger read(Class<?> cls,
                                         Map<String,io.swagger.models.Tag> parentTags,
                                         List<io.swagger.models.parameters.Parameter> parentParameters)

readImplicitParam

protected io.swagger.models.parameters.Parameter readImplicitParam(io.swagger.annotations.ApiImplicitParam param)

readSwaggerConfig

protected void readSwaggerConfig(Class<?> cls,
                                 io.swagger.annotations.SwaggerDefinition config)

readInfoConfig

protected void readInfoConfig(io.swagger.annotations.SwaggerDefinition config)

getSubResource

protected Class<?> getSubResource(Method method)

extractTags

protected Set<String> extractTags(io.swagger.annotations.Api api)

parseMethod

public io.swagger.models.Operation parseMethod(Method method)

extractOperationMethod

public String extractOperationMethod(io.swagger.annotations.ApiOperation apiOperation,
                                     Method method,
                                     Iterator<SwaggerExtension> chain)

getOperationId

protected String getOperationId(String operationId)