org.ssssssss.magicapi.swagger.entity

类 SwaggerEntity

java.lang.Object

org.ssssssss.magicapi.swagger.entity.SwaggerEntity

public class SwaggerEntity
extends Object

Swagger接口信息

作者:

mxd

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	SwaggerEntity.ApiKeyAuth
static class	SwaggerEntity.BasicAuth
static class	SwaggerEntity.Concat
static class	SwaggerEntity.Info
static class	SwaggerEntity.License
static class	SwaggerEntity.OAuth2
static class	SwaggerEntity.Parameter
static class	SwaggerEntity.Path
static class	SwaggerEntity.Tag

构造器概要

构造器

构造器和说明
SwaggerEntity()

方法概要

限定符和类型	方法和说明
void	addDefinitions(String path, Object definition)
void	addPath(String path, String method, SwaggerEntity.Path pathInfo)
void	addSecurity(Map<String,Object> map)
void	addSecurityDefinitions(Map<String,Object> map)
void	addTag(String name, String description)
static Map<String,Object>	createParameter(boolean required, String name, String in, String type, String description, Object example)
String	getBasePath()
Map<String,Object>	getDefinitions()
String	getHost()
SwaggerEntity.Info	getInfo()
Map<String,Map<String,SwaggerEntity.Path>>	getPaths()
List<Map<String,Object>>	getSecurity()
Map<String,Object>	getSecurityDefinitions()
String	getSwagger()
Set<SwaggerEntity.Tag>	getTags()
void	setBasePath(String basePath)
void	setHost(String host)
void	setInfo(SwaggerEntity.Info info)
void	setSwagger(String swagger)

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

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

构造器详细资料

SwaggerEntity

public SwaggerEntity()

方法详细资料

createParameter

public static Map<String,Object> createParameter(boolean required,
                                                 String name,
                                                 String in,
                                                 String type,
                                                 String description,
                                                 Object example)

getInfo

public SwaggerEntity.Info getInfo()

setInfo

public void setInfo(SwaggerEntity.Info info)

addPath

public void addPath(String path,
                    String method,
                    SwaggerEntity.Path pathInfo)

addTag

public void addTag(String name,
                   String description)

getHost

public String getHost()

setHost

public void setHost(String host)

getSwagger

public String getSwagger()

setSwagger

public void setSwagger(String swagger)

getBasePath

public String getBasePath()

setBasePath

public void setBasePath(String basePath)

getDefinitions

public Map<String,Object> getDefinitions()

addDefinitions

public void addDefinitions(String path,
                           Object definition)

getTags

public Set<SwaggerEntity.Tag> getTags()

getPaths

public Map<String,Map<String,SwaggerEntity.Path>> getPaths()

getSecurityDefinitions

public Map<String,Object> getSecurityDefinitions()

getSecurity

public List<Map<String,Object>> getSecurity()

addSecurityDefinitions

public void addSecurityDefinitions(Map<String,Object> map)

addSecurity

public void addSecurity(Map<String,Object> map)