Package io.muserver.openapi

Class OpenAPIObject

java.lang.Object

io.muserver.openapi.OpenAPIObject

public class OpenAPIObject
extends java.lang.Object

See Also:

OpenAPIObjectBuilder

Method Summary

Modifier and Type	Method	Description
ComponentsObject	components()
ExternalDocumentationObject	externalDocs()
InfoObject	info()
java.lang.String	openApi()
PathsObject	paths()
java.util.List<SecurityRequirementObject>	security()
java.util.List<ServerObject>	servers()
java.util.List<TagObject>	tags()
void	writeJson(java.io.Writer writer)

Methods inherited from class java.lang.Object

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

Method Detail

writeJson

public void writeJson(java.io.Writer writer)
               throws java.io.IOException

Throws:

java.io.IOException

openApi

public java.lang.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 java.util.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 java.util.List<SecurityRequirementObject> security()

Returns:

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

tags

public java.util.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)