Swagger (swagger-models 1.5.1-M1 API)

java.lang.Object
- com.wordnik.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 List<Scheme>`	`schemes`
`protected Map<String,SecuritySchemeDefinition>`	`securityDefinitions`
`protected List<SecurityRequirement>`	`securityRequirement`
`protected String`	`swagger`

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`	`addSecurityDefinition(String name, SecuritySchemeDefinition securityDefinition)`
`Swagger`	`basePath(String basePath)`
`Swagger`	`consumes(List<String> consumes)`
`Swagger`	`consumes(String consumes)`
`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()`
`List<Scheme>`	`getSchemes()`
`Map<String,SecuritySchemeDefinition>`	`getSecurityDefinitions()`
`String`	`getSwagger()`
`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`	`scheme(Scheme scheme)`
`Swagger`	`schemes(List<Scheme> schemes)`
`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`	`setSchemes(List<Scheme> schemes)`
`void`	`setSecurityDefinitions(Map<String,SecuritySchemeDefinition> securityDefinitions)`
`void`	`setSwagger(String swagger)`

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

Field Detail

swagger
```
protected String swagger
```

info
```
protected Info info
```

host
```
protected String host
```

basePath
```
protected String basePath
```

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

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

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

securityRequirement

protected List<SecurityRequirement> securityRequirement

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

securityDefinitions

protected Map<String,SecuritySchemeDefinition> securityDefinitions

definitions

protected Map<String,Model> definitions

parameters

protected Map<String,Parameter> parameters

externalDocs
```
protected ExternalDocs externalDocs
```

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)

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)

parameter

public Swagger parameter(String key,
                Parameter parameter)

securityDefinition

public Swagger securityDefinition(String name,
                         SecuritySchemeDefinition securityDefinition)

model

public Swagger model(String name,
            Model model)

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)
```

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)

setDefinitions

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

getDefinitions

public Map<String,Model> getDefinitions()

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)

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

setExternalDocs

public void setExternalDocs(ExternalDocs value)

Class Swagger

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

swagger

info

host

basePath

schemes

consumes

produces

securityRequirement

paths

securityDefinitions

definitions

parameters

externalDocs

Constructor Detail

Swagger

Method Detail

info

host

basePath

externalDocs

schemes

scheme

consumes

consumes

produces

produces

paths

path

parameter

securityDefinition

model

getSwagger

setSwagger

getInfo

setInfo

getHost

setHost

getBasePath

setBasePath

getSchemes

setSchemes

addScheme

getConsumes

setConsumes

addConsumes

getProduces

setProduces

addProduces

getPaths

setPaths

getPath

getSecurityDefinitions

setSecurityDefinitions

addSecurityDefinition

setDefinitions

getDefinitions

addDefinition

getParameters

setParameters

getParameter

addParameter

getExternalDocs

setExternalDocs