public class Swagger
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
basePath |
protected java.util.List<java.lang.String> |
consumes |
protected java.util.Map<java.lang.String,Model> |
definitions |
protected ExternalDocs |
externalDocs |
protected java.lang.String |
host |
protected Info |
info |
protected java.util.Map<java.lang.String,Parameter> |
parameters |
protected java.util.Map<java.lang.String,Path> |
paths |
protected java.util.List<java.lang.String> |
produces |
protected java.util.Map<java.lang.String,Response> |
responses |
protected java.util.List<Scheme> |
schemes |
protected java.util.List<SecurityRequirement> |
security |
protected java.util.Map<java.lang.String,SecuritySchemeDefinition> |
securityDefinitions |
protected java.lang.String |
swagger |
protected java.util.List<Tag> |
tags |
protected java.util.Map<java.lang.String,java.lang.Object> |
vendorExtensions |
Constructor and Description |
---|
Swagger() |
Modifier and Type | Method and Description |
---|---|
void |
addConsumes(java.lang.String consumes) |
void |
addDefinition(java.lang.String key,
Model model) |
void |
addParameter(java.lang.String key,
Parameter parameter) |
void |
addProduces(java.lang.String produces) |
void |
addScheme(Scheme scheme) |
void |
addSecurity(SecurityRequirement securityRequirement) |
void |
addSecurityDefinition(SecurityRequirement securityRequirement)
Deprecated.
|
void |
addSecurityDefinition(java.lang.String name,
SecuritySchemeDefinition securityDefinition) |
void |
addTag(Tag tag) |
Swagger |
basePath(java.lang.String basePath) |
Swagger |
consumes(java.util.List<java.lang.String> consumes) |
Swagger |
consumes(java.lang.String consumes) |
boolean |
equals(java.lang.Object obj) |
Swagger |
externalDocs(ExternalDocs value) |
java.lang.String |
getBasePath() |
java.util.List<java.lang.String> |
getConsumes() |
java.util.Map<java.lang.String,Model> |
getDefinitions() |
ExternalDocs |
getExternalDocs() |
java.lang.String |
getHost() |
Info |
getInfo() |
Parameter |
getParameter(java.lang.String parameter) |
java.util.Map<java.lang.String,Parameter> |
getParameters() |
Path |
getPath(java.lang.String path) |
java.util.Map<java.lang.String,Path> |
getPaths() |
java.util.List<java.lang.String> |
getProduces() |
java.util.Map<java.lang.String,Response> |
getResponses() |
java.util.List<Scheme> |
getSchemes() |
java.util.List<SecurityRequirement> |
getSecurity() |
java.util.Map<java.lang.String,SecuritySchemeDefinition> |
getSecurityDefinitions() |
java.util.List<SecurityRequirement> |
getSecurityRequirement()
Deprecated.
Use
getSecurity() . |
java.lang.String |
getSwagger() |
Tag |
getTag(java.lang.String tagName) |
java.util.List<Tag> |
getTags() |
java.util.Map<java.lang.String,java.lang.Object> |
getVendorExtensions() |
int |
hashCode() |
Swagger |
host(java.lang.String host) |
Swagger |
info(Info info) |
Swagger |
model(java.lang.String name,
Model model) |
Swagger |
parameter(java.lang.String key,
Parameter parameter) |
Swagger |
path(java.lang.String key,
Path path) |
Swagger |
paths(java.util.Map<java.lang.String,Path> paths) |
Swagger |
produces(java.util.List<java.lang.String> produces) |
Swagger |
produces(java.lang.String produces) |
Swagger |
response(java.lang.String key,
Response response) |
Swagger |
responses(java.util.Map<java.lang.String,Response> responses) |
Swagger |
scheme(Scheme scheme) |
Swagger |
schemes(java.util.List<Scheme> schemes) |
Swagger |
security(SecurityRequirement securityRequirement) |
Swagger |
securityDefinition(java.lang.String name,
SecuritySchemeDefinition securityDefinition) |
void |
setBasePath(java.lang.String basePath) |
void |
setConsumes(java.util.List<java.lang.String> consumes) |
void |
setDefinitions(java.util.Map<java.lang.String,Model> definitions) |
void |
setExternalDocs(ExternalDocs value) |
void |
setHost(java.lang.String host) |
void |
setInfo(Info info) |
void |
setParameters(java.util.Map<java.lang.String,Parameter> parameters) |
void |
setPaths(java.util.Map<java.lang.String,Path> paths) |
void |
setProduces(java.util.List<java.lang.String> produces) |
void |
setResponses(java.util.Map<java.lang.String,Response> responses) |
void |
setSchemes(java.util.List<Scheme> schemes) |
void |
setSecurity(java.util.List<SecurityRequirement> securityRequirements) |
void |
setSecurityDefinitions(java.util.Map<java.lang.String,SecuritySchemeDefinition> securityDefinitions) |
void |
setSecurityRequirement(java.util.List<SecurityRequirement> securityRequirements)
Deprecated.
Use
setSecurity(List) . |
void |
setSwagger(java.lang.String swagger) |
void |
setTags(java.util.List<Tag> tags) |
void |
setVendorExtension(java.lang.String name,
java.lang.Object value) |
void |
setVendorExtensions(java.util.Map<java.lang.String,java.lang.Object> vendorExtensions) |
Swagger |
tag(Tag tag) |
Swagger |
tags(java.util.List<Tag> tags) |
Swagger |
vendorExtension(java.lang.String key,
java.lang.Object extension) |
Swagger |
vendorExtensions(java.util.Map<java.lang.String,java.lang.Object> vendorExtensions) |
protected java.lang.String swagger
protected Info info
protected java.lang.String host
protected java.lang.String basePath
protected java.util.List<Tag> tags
protected java.util.List<Scheme> schemes
protected java.util.List<java.lang.String> consumes
protected java.util.List<java.lang.String> produces
protected java.util.List<SecurityRequirement> security
protected java.util.Map<java.lang.String,Path> paths
protected java.util.Map<java.lang.String,SecuritySchemeDefinition> securityDefinitions
protected java.util.Map<java.lang.String,Model> definitions
protected java.util.Map<java.lang.String,Parameter> parameters
protected java.util.Map<java.lang.String,Response> responses
protected ExternalDocs externalDocs
protected java.util.Map<java.lang.String,java.lang.Object> vendorExtensions
public Swagger host(java.lang.String host)
public Swagger basePath(java.lang.String basePath)
public Swagger externalDocs(ExternalDocs value)
public Swagger consumes(java.util.List<java.lang.String> consumes)
public Swagger consumes(java.lang.String consumes)
public Swagger produces(java.util.List<java.lang.String> produces)
public Swagger produces(java.lang.String produces)
public Swagger securityDefinition(java.lang.String name, SecuritySchemeDefinition securityDefinition)
public Swagger security(SecurityRequirement securityRequirement)
public Swagger vendorExtension(java.lang.String key, java.lang.Object extension)
public java.lang.String getSwagger()
public void setSwagger(java.lang.String swagger)
public Info getInfo()
public void setInfo(Info info)
public java.lang.String getHost()
public void setHost(java.lang.String host)
public java.lang.String getBasePath()
public void setBasePath(java.lang.String basePath)
public java.util.List<Scheme> getSchemes()
public void setSchemes(java.util.List<Scheme> schemes)
public void addScheme(Scheme scheme)
public java.util.List<Tag> getTags()
public void setTags(java.util.List<Tag> tags)
public Tag getTag(java.lang.String tagName)
public void addTag(Tag tag)
public java.util.List<java.lang.String> getConsumes()
public void setConsumes(java.util.List<java.lang.String> consumes)
public void addConsumes(java.lang.String consumes)
public java.util.List<java.lang.String> getProduces()
public void setProduces(java.util.List<java.lang.String> produces)
public void addProduces(java.lang.String produces)
public java.util.Map<java.lang.String,Path> getPaths()
public void setPaths(java.util.Map<java.lang.String,Path> paths)
public Path getPath(java.lang.String path)
public java.util.Map<java.lang.String,SecuritySchemeDefinition> getSecurityDefinitions()
public void setSecurityDefinitions(java.util.Map<java.lang.String,SecuritySchemeDefinition> securityDefinitions)
public void addSecurityDefinition(java.lang.String name, SecuritySchemeDefinition securityDefinition)
@Deprecated public java.util.List<SecurityRequirement> getSecurityRequirement()
getSecurity()
.@Deprecated public void setSecurityRequirement(java.util.List<SecurityRequirement> securityRequirements)
setSecurity(List)
.@Deprecated public void addSecurityDefinition(SecurityRequirement securityRequirement)
addSecurity(SecurityRequirement)
.public java.util.List<SecurityRequirement> getSecurity()
public void setSecurity(java.util.List<SecurityRequirement> securityRequirements)
public void addSecurity(SecurityRequirement securityRequirement)
public java.util.Map<java.lang.String,Model> getDefinitions()
public void setDefinitions(java.util.Map<java.lang.String,Model> definitions)
public void addDefinition(java.lang.String key, Model model)
public java.util.Map<java.lang.String,Parameter> getParameters()
public void setParameters(java.util.Map<java.lang.String,Parameter> parameters)
public Parameter getParameter(java.lang.String parameter)
public void addParameter(java.lang.String key, Parameter parameter)
public java.util.Map<java.lang.String,Response> getResponses()
public void setResponses(java.util.Map<java.lang.String,Response> responses)
public ExternalDocs getExternalDocs()
public void setExternalDocs(ExternalDocs value)
public java.util.Map<java.lang.String,java.lang.Object> getVendorExtensions()
public void setVendorExtension(java.lang.String name, java.lang.Object value)
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public Swagger vendorExtensions(java.util.Map<java.lang.String,java.lang.Object> vendorExtensions)
public void setVendorExtensions(java.util.Map<java.lang.String,java.lang.Object> vendorExtensions)
Copyright © 2020 JBoss by Red Hat. All Rights Reserved.