Package io.smallrye.openapi.api

Class OpenApiDocument

java.lang.Object

io.smallrye.openapi.api.OpenApiDocument

public class OpenApiDocument
extends Object

Holds the final OpenAPI document produced during the startup of the app.

Note that the model must be initialized first!

Author:

Martin Kouba

Field Summary

Fields

Modifier and Type	Field	Description
static OpenApiDocument	INSTANCE

Method Summary

Modifier and Type	Method	Description
void	archiveName(String archiveName)
void	config(OpenApiConfig config)
void	filter(org.eclipse.microprofile.openapi.OASFilter filter)
org.eclipse.microprofile.openapi.models.OpenAPI	get()
void	initialize()
boolean	isSet()
void	modelFromAnnotations(org.eclipse.microprofile.openapi.models.OpenAPI model)
void	modelFromReader(org.eclipse.microprofile.openapi.models.OpenAPI model)
void	modelFromStaticFile(org.eclipse.microprofile.openapi.models.OpenAPI model)
static OpenApiDocument	newInstance()
void	reset()	Reset the holder.
void	set(org.eclipse.microprofile.openapi.models.OpenAPI model)	Set the final OpenAPI document.
void	version(String version)

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final OpenApiDocument INSTANCE

Method Detail

newInstance

public static OpenApiDocument newInstance()

get

public org.eclipse.microprofile.openapi.models.OpenAPI get()

Returns:

the final OpenAPI document produced during the startup of the app

Throws:

IllegalStateException - If the final model is not initialized yet

set

public void set(org.eclipse.microprofile.openapi.models.OpenAPI model)

Set the final OpenAPI document. This method should only be used for testing.

Parameters:

model - OpenAPI model instance

reset

public void reset()

Reset the holder.

isSet

public boolean isSet()

Returns:

true if model initialized

config

public void config(OpenApiConfig config)

modelFromAnnotations

public void modelFromAnnotations(org.eclipse.microprofile.openapi.models.OpenAPI model)

modelFromReader

public void modelFromReader(org.eclipse.microprofile.openapi.models.OpenAPI model)

modelFromStaticFile

public void modelFromStaticFile(org.eclipse.microprofile.openapi.models.OpenAPI model)

filter

public void filter(org.eclipse.microprofile.openapi.OASFilter filter)

archiveName

public void archiveName(String archiveName)

version

public void version(String version)

initialize

public void initialize()