Swagger (swagger-models 1.5.13 API)

java.lang.Object
- io.swagger.models.Swagger

```
public class Swagger
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`basePath`
`protected List<String>`	`consumes`
`protected Map<String,Model>`	`definitions`
`protected ExternalDocs`	`externalDocs`
`protected String`	`host`
`protected Info`	`info`
`protected Map<String,Parameter>`	`parameters`
`protected Map<String,Path>`	`paths`
`protected List<String>`	`produces`
`protected Map<String,Response>`	`responses`
`protected List<Scheme>`	`schemes`
`protected List<SecurityRequirement>`	`security`
`protected Map<String,SecuritySchemeDefinition>`	`securityDefinitions`
`protected String`	`swagger`
`protected List<Tag>`	`tags`
`protected Map<String,Object>`	`vendorExtensions`

Constructor Summary

Constructors
Constructor and Description

Swagger()

Constructors
Constructor and Description
`Swagger()`

Method Summary

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

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

swagger
```
protected String swagger
```

info
```
protected Info info
```

host
```
protected String host
```

basePath
```
protected String basePath
```

tags
```
protected List<Tag> tags
```

schemes
```
protected List<Scheme> schemes
```

consumes
```
protected List<String> consumes
```

produces
```
protected List<String> produces
```

security

protected List<SecurityRequirement> security

paths
```
protected Map<String,Path> paths
```

securityDefinitions

protected Map<String,SecuritySchemeDefinition> securityDefinitions

definitions

protected Map<String,Model> definitions

parameters

protected Map<String,Parameter> parameters

responses

protected Map<String,Response> responses

externalDocs
```
protected ExternalDocs externalDocs
```

vendorExtensions

protected Map<String,Object> vendorExtensions

Constructor Detail
- Swagger
```
public Swagger()
```

Method Detail

info
```
public Swagger info(Info info)
```

host
```
public Swagger host(String host)
```

basePath

public Swagger basePath(String basePath)

externalDocs

public Swagger externalDocs(ExternalDocs value)

tags
```
public Swagger tags(List<Tag> tags)
```

tag
```
public Swagger tag(Tag tag)
```

schemes

public Swagger schemes(List<Scheme> schemes)

scheme
```
public Swagger scheme(Scheme scheme)
```

consumes

public Swagger consumes(List<String> consumes)

consumes

public Swagger consumes(String consumes)

produces

public Swagger produces(List<String> produces)

produces

public Swagger produces(String produces)

paths

public Swagger paths(Map<String,Path> paths)

path

public Swagger path(String key,
           Path path)

responses

public Swagger responses(Map<String,Response> responses)

response

public Swagger response(String key,
               Response response)

parameter

public Swagger parameter(String key,
                Parameter parameter)

securityDefinition

public Swagger securityDefinition(String name,
                         SecuritySchemeDefinition securityDefinition)

model

public Swagger model(String name,
            Model model)

security

public Swagger security(SecurityRequirement securityRequirement)

vendorExtension

public Swagger vendorExtension(String key,
                      Object extension)

getSwagger
```
public String getSwagger()
```

setSwagger

public void setSwagger(String swagger)

getInfo
```
public Info getInfo()
```

setInfo
```
public void setInfo(Info info)
```

getHost
```
public String getHost()
```

setHost
```
public void setHost(String host)
```

getBasePath
```
public String getBasePath()
```

setBasePath

public void setBasePath(String basePath)

getSchemes
```
public List<Scheme> getSchemes()
```

setSchemes

public void setSchemes(List<Scheme> schemes)

addScheme
```
public void addScheme(Scheme scheme)
```

getTags
```
public List<Tag> getTags()
```

setTags
```
public void setTags(List<Tag> tags)
```

getTag
```
public Tag getTag(String tagName)
```

addTag
```
public void addTag(Tag tag)
```

getConsumes
```
public List<String> getConsumes()
```

setConsumes

public void setConsumes(List<String> consumes)

addConsumes

public void addConsumes(String consumes)

getProduces
```
public List<String> getProduces()
```

setProduces

public void setProduces(List<String> produces)

addProduces

public void addProduces(String produces)

getPaths
```
public Map<String,Path> getPaths()
```

setPaths

public void setPaths(Map<String,Path> paths)

getPath
```
public Path getPath(String path)
```

getSecurityDefinitions

public Map<String,SecuritySchemeDefinition> getSecurityDefinitions()

setSecurityDefinitions

public void setSecurityDefinitions(Map<String,SecuritySchemeDefinition> securityDefinitions)

addSecurityDefinition

public void addSecurityDefinition(String name,
                         SecuritySchemeDefinition securityDefinition)

getSecurityRequirement

@Deprecated
public List<SecurityRequirement> getSecurityRequirement()

Deprecated. Use getSecurity().

setSecurityRequirement

@Deprecated
public void setSecurityRequirement(List<SecurityRequirement> securityRequirements)

Deprecated. Use setSecurity(List).

addSecurityDefinition

@Deprecated
public void addSecurityDefinition(SecurityRequirement securityRequirement)

Deprecated. Use addSecurity(SecurityRequirement).

getSecurity

public List<SecurityRequirement> getSecurity()

setSecurity

public void setSecurity(List<SecurityRequirement> securityRequirements)

addSecurity

public void addSecurity(SecurityRequirement securityRequirement)

getDefinitions

public Map<String,Model> getDefinitions()

setDefinitions

public void setDefinitions(Map<String,Model> definitions)

addDefinition

public void addDefinition(String key,
                 Model model)

getParameters

public Map<String,Parameter> getParameters()

setParameters

public void setParameters(Map<String,Parameter> parameters)

getParameter

public Parameter getParameter(String parameter)

addParameter

public void addParameter(String key,
                Parameter parameter)

getResponses

public Map<String,Response> getResponses()

setResponses

public void setResponses(Map<String,Response> responses)

getExternalDocs
```
public ExternalDocs getExternalDocs()
```

setExternalDocs

public void setExternalDocs(ExternalDocs value)

getVendorExtensions

public Map<String,Object> getVendorExtensions()

setVendorExtension

public void setVendorExtension(String name,
                      Object value)

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

vendorExtensions

public Swagger vendorExtensions(Map<String,Object> vendorExtensions)

setVendorExtensions

public void setVendorExtensions(Map<String,Object> vendorExtensions)

Class Swagger

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

swagger

info

host

basePath

tags

schemes

consumes

produces

security

paths

securityDefinitions

definitions

parameters

responses

externalDocs

vendorExtensions

Constructor Detail

Swagger

Method Detail

info

host

basePath

externalDocs

tags

tag

schemes

scheme

consumes

consumes

produces

produces

paths

path

responses

response

parameter

securityDefinition

model

security

vendorExtension

getSwagger

setSwagger

getInfo

setInfo

getHost

setHost

getBasePath

setBasePath

getSchemes

setSchemes

addScheme

getTags

setTags

getTag

addTag

getConsumes

setConsumes

addConsumes

getProduces

setProduces

addProduces

getPaths

setPaths

getPath

getSecurityDefinitions

setSecurityDefinitions

addSecurityDefinition

getSecurityRequirement

setSecurityRequirement

addSecurityDefinition

getSecurity

setSecurity

addSecurity

getDefinitions