OpenAPI (swagger-models 2.2.8 API)

java.lang.Object
- io.swagger.v3.oas.models.OpenAPI

```
public class OpenAPI
extends Object
```
OpenAPI

See Also:

"https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md", "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md"

Constructor Summary

Constructors
Constructor and Description

OpenAPI()

OpenAPI(SpecVersion specVersion)

Constructors
Constructor and Description
`OpenAPI()`
`OpenAPI(SpecVersion specVersion)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExtension(String name, Object value)`
`void`	`addExtension31(String name, Object value)`
`OpenAPI`	`addSecurityItem(SecurityRequirement securityItem)`
`OpenAPI`	`addServersItem(Server serversItem)`
`OpenAPI`	`addTagsItem(Tag tagsItem)`
`OpenAPI`	`addWebhooks(String key, PathItem pathItem)`
`OpenAPI`	`components(Components components)`
`boolean`	`equals(Object o)`
`OpenAPI`	`extensions(Map<String,Object> extensions)`
`OpenAPI`	`externalDocs(ExternalDocumentation externalDocs)`
`Components`	`getComponents()` returns the components property from a OpenAPI instance.
`Map<String,Object>`	`getExtensions()`
`ExternalDocumentation`	`getExternalDocs()` returns the externalDocs property from a OpenAPI instance.
`Info`	`getInfo()` returns the info property from a OpenAPI instance.
`String`	`getJsonSchemaDialect()`
`String`	`getOpenapi()` returns the openapi property from a OpenAPI instance.
`Paths`	`getPaths()` returns the paths property from a OpenAPI instance.
`List<SecurityRequirement>`	`getSecurity()` returns the security property from a OpenAPI instance.
`List<Server>`	`getServers()` Servers defined in the API
`SpecVersion`	`getSpecVersion()`
`List<Tag>`	`getTags()` returns the tags property from a OpenAPI instance.
`Map<String,PathItem>`	`getWebhooks()` returns the webhooks property from a OpenAPI instance.
`int`	`hashCode()`
`OpenAPI`	`info(Info info)`
`OpenAPI`	`jsonSchemaDialect(String jsonSchemaDialect)`
`OpenAPI`	`openapi(String openapi)`
`OpenAPI`	`path(String name, PathItem path)`
`OpenAPI`	`paths(Paths paths)`
`OpenAPI`	`schema(String name, Schema schema)`
`OpenAPI`	`schemaRequirement(String name, SecurityScheme securityScheme)`
`OpenAPI`	`security(List<SecurityRequirement> security)`
`OpenAPI`	`servers(List<Server> servers)`
`void`	`setComponents(Components components)`
`void`	`setExtensions(Map<String,Object> extensions)`
`void`	`setExternalDocs(ExternalDocumentation externalDocs)`
`void`	`setInfo(Info info)`
`void`	`setJsonSchemaDialect(String jsonSchemaDialect)`
`void`	`setOpenapi(String openapi)`
`void`	`setPaths(Paths paths)`
`void`	`setSecurity(List<SecurityRequirement> security)`
`void`	`setServers(List<Server> servers)`
`void`	`setSpecVersion(SpecVersion specVersion)`
`void`	`setTags(List<Tag> tags)`
`void`	`setWebhooks(Map<String,PathItem> webhooks)`
`OpenAPI`	`specVersion(SpecVersion specVersion)`
`OpenAPI`	`tags(List<Tag> tags)`
`String`	`toString()`
`OpenAPI`	`webhooks(Map<String,PathItem> webhooks)`

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

Constructor Detail

OpenAPI
```
public OpenAPI()
```

OpenAPI

public OpenAPI(SpecVersion specVersion)

Method Detail

getSpecVersion
```
public SpecVersion getSpecVersion()
```

setSpecVersion

public void setSpecVersion(SpecVersion specVersion)

specVersion

public OpenAPI specVersion(SpecVersion specVersion)

getOpenapi
```
public String getOpenapi()
```
returns the openapi property from a OpenAPI instance.

Returns:

String openapi

setOpenapi

public void setOpenapi(String openapi)

openapi

public OpenAPI openapi(String openapi)

getInfo
```
public Info getInfo()
```
returns the info property from a OpenAPI instance.

Returns:

Info info

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

info
```
public OpenAPI info(Info info)
```

getExternalDocs
```
public ExternalDocumentation getExternalDocs()
```
returns the externalDocs property from a OpenAPI instance.

Returns:

ExternalDocumentation externalDocs

setExternalDocs

public void setExternalDocs(ExternalDocumentation externalDocs)

externalDocs

public OpenAPI externalDocs(ExternalDocumentation externalDocs)

getServers
```
public List<Server> getServers()
```
Servers defined in the API

Returns:

List<Server> servers

setServers

public void setServers(List<Server> servers)

servers

public OpenAPI servers(List<Server> servers)

addServersItem

public OpenAPI addServersItem(Server serversItem)

getSecurity
```
public List<SecurityRequirement> getSecurity()
```
returns the security property from a OpenAPI instance.

Returns:

List<SecurityRequirement> security

setSecurity

public void setSecurity(List<SecurityRequirement> security)

security

public OpenAPI security(List<SecurityRequirement> security)

addSecurityItem

public OpenAPI addSecurityItem(SecurityRequirement securityItem)

getTags
```
public List<Tag> getTags()
```
returns the tags property from a OpenAPI instance.

Returns:

List<Tag> tags

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

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

addTagsItem

public OpenAPI addTagsItem(Tag tagsItem)

getPaths
```
public Paths getPaths()
```
returns the paths property from a OpenAPI instance.

Returns:

Paths paths

setPaths
```
public void setPaths(Paths paths)
```

paths
```
public OpenAPI paths(Paths paths)
```

getComponents
```
public Components getComponents()
```
returns the components property from a OpenAPI instance.

Returns:

Components components

setComponents

public void setComponents(Components components)

components

public OpenAPI components(Components components)

path

public OpenAPI path(String name,
                    PathItem path)

schema

public OpenAPI schema(String name,
                      Schema schema)

schemaRequirement

public OpenAPI schemaRequirement(String name,
                                 SecurityScheme securityScheme)

getWebhooks
```
public Map<String,PathItem> getWebhooks()
```
returns the webhooks property from a OpenAPI instance.

Returns:

Map<String, PathItem> webhooks

Since:

2.2.0 (OpenAPI 3.1.0)

setWebhooks

public void setWebhooks(Map<String,PathItem> webhooks)

webhooks

public OpenAPI webhooks(Map<String,PathItem> webhooks)

addWebhooks

public OpenAPI addWebhooks(String key,
                           PathItem pathItem)

getJsonSchemaDialect
```
public String getJsonSchemaDialect()
```
Since:

2.2.0 (OpenAPI 3.1.0)

setJsonSchemaDialect

public void setJsonSchemaDialect(String jsonSchemaDialect)

Since:: 2.2.0 (OpenAPI 3.1.0)

jsonSchemaDialect

public OpenAPI jsonSchemaDialect(String jsonSchemaDialect)

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

equals in class Object

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

hashCode in class Object

getExtensions

public Map<String,Object> getExtensions()

addExtension

public void addExtension(String name,
                         Object value)

addExtension31

public void addExtension31(String name,
                           Object value)

setExtensions

public void setExtensions(Map<String,Object> extensions)

extensions

public OpenAPI extensions(Map<String,Object> extensions)

toString
```
public String toString()
```
Overrides:

toString in class Object

Class OpenAPI

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OpenAPI

OpenAPI

Method Detail

getSpecVersion

setSpecVersion

specVersion

getOpenapi

setOpenapi

openapi

getInfo

setInfo

info

getExternalDocs

setExternalDocs

externalDocs

getServers

setServers

servers

addServersItem

getSecurity

setSecurity

security

addSecurityItem

getTags

setTags

tags

addTagsItem

getPaths

setPaths

paths

getComponents

setComponents

components

path

schema

schemaRequirement

getWebhooks

setWebhooks

webhooks

addWebhooks

getJsonSchemaDialect

setJsonSchemaDialect

jsonSchemaDialect

equals

hashCode

getExtensions

addExtension

addExtension31

setExtensions

extensions

toString