SwaggerApiBuilder (vertigo-vega 3.3.0 API)

java.lang.Object
- io.vertigo.vega.impl.webservice.catalog.SwaggerApiBuilder

All Implemented Interfaces:

io.vertigo.core.lang.Builder<SwaggerApi>
```
public final class SwaggerApiBuilder
extends Object
implements io.vertigo.core.lang.Builder<SwaggerApi>
```
Swagger WebService to list services published.

Author:

npiedeloup (22 juil. 2014 11:12:02)

See Also:

"https://github.com/wordnik/swagger-spec/blob/master/versions/2.0.md"

Constructor Summary

Constructors
Constructor Description

SwaggerApiBuilder()
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SwaggerApi`	`build()`
`SwaggerApiBuilder`	`withContextPath(String contextPath)`
`SwaggerApiBuilder`	`withTypesAdapterMap(Map<Class,io.vertigo.core.lang.BasicTypeAdapter> typeAdapters)`
`SwaggerApiBuilder`	`withWebServiceDefinitions(Collection<WebServiceDefinition> webServiceDefinitions)`

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

Constructor Detail
- SwaggerApiBuilder
```
public SwaggerApiBuilder()
```
  Constructor.

Method Detail

withContextPath
```
public SwaggerApiBuilder withContextPath(String contextPath)
```
Parameters:

contextPath - ContextPath of API request

Returns:

this builder

withTypesAdapterMap

public SwaggerApiBuilder withTypesAdapterMap(Map<Class,io.vertigo.core.lang.BasicTypeAdapter> typeAdapters)

withWebServiceDefinitions
```
public SwaggerApiBuilder withWebServiceDefinitions(Collection<WebServiceDefinition> webServiceDefinitions)
```
Parameters:

webServiceDefinitions - WebServiceDefinitions to use for swagger api

Returns:

this builder

build
```
public SwaggerApi build()
```
Specified by:

build in interface io.vertigo.core.lang.Builder<SwaggerApi>