io.muserver.openapi

Class OpenAPIObject

java.lang.Object

io.muserver.openapi.OpenAPIObject

public class OpenAPIObject
extends Object

See Also:

OpenAPIObjectBuilder

Field Summary

Fields

Modifier and Type	Field and Description
ComponentsObject	components Deprecated.
ExternalDocumentationObject	externalDocs Deprecated.
InfoObject	info Deprecated.
String	openapi Deprecated.
PathsObject	paths Deprecated.
List<SecurityRequirementObject>	security Deprecated.
List<ServerObject>	servers Deprecated.
List<TagObject>	tags Deprecated.

Method Summary

Modifier and Type	Method and Description
ComponentsObject	components()
ExternalDocumentationObject	externalDocs()
InfoObject	info()
String	openApi()
PathsObject	paths()
List<SecurityRequirementObject>	security()
List<ServerObject>	servers()
List<TagObject>	tags()
void	writeJson(Writer writer) Writes this object as a JSON Object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

openapi

@Deprecated
public final String openapi

Deprecated.

Use openApi() instead

See Also:

Constant Field Values

info

@Deprecated
public final InfoObject info

Deprecated.

Use info() instead

servers

@Deprecated
public final List<ServerObject> servers

Deprecated.

Use servers() instead

paths

@Deprecated
public final PathsObject paths

Deprecated.

Use paths() instead

components

@Deprecated
public final ComponentsObject components

Deprecated.

Use components() instead

security

@Deprecated
public final List<SecurityRequirementObject> security

Deprecated.

Use security() instead

tags

@Deprecated
public final List<TagObject> tags

Deprecated.

Use tags() instead

externalDocs

@Deprecated
public final ExternalDocumentationObject externalDocs

Deprecated.

Use externalDocs() instead

Method Detail

writeJson

public void writeJson(Writer writer)
               throws IOException

Writes this object as a JSON Object

Parameters:

writer - The writer to write to

Throws:

IOException - Thrown if the writer throws this while writing

openApi

public String openApi()

Returns:

The OpenAPI spec version this document conforms to

info

public InfoObject info()

Returns:

the value described in OpenAPIObjectBuilder.withInfo(io.muserver.openapi.InfoObject)

servers

public List<ServerObject> servers()

Returns:

the value described in OpenAPIObjectBuilder.withServers(java.util.List<io.muserver.openapi.ServerObject>)

paths

public PathsObject paths()

Returns:

the value described in OpenAPIObjectBuilder.withPaths(io.muserver.openapi.PathsObject)

components

public ComponentsObject components()

Returns:

the value described in OpenAPIObjectBuilder.withComponents(io.muserver.openapi.ComponentsObject)

security

public List<SecurityRequirementObject> security()

Returns:

the value described in OpenAPIObjectBuilder.withSecurity(java.util.List<io.muserver.openapi.SecurityRequirementObject>)

tags

public List<TagObject> tags()

Returns:

the value described in OpenAPIObjectBuilder.withTags(java.util.List<io.muserver.openapi.TagObject>)

externalDocs

public ExternalDocumentationObject externalDocs()

Returns:

the value described in OpenAPIObjectBuilder.withExternalDocs(io.muserver.openapi.ExternalDocumentationObject)