Package io.smallrye.openapi.api

Class SmallRyeOpenAPI

java.lang.Object

io.smallrye.openapi.api.SmallRyeOpenAPI

public class SmallRyeOpenAPI
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SmallRyeOpenAPI.Builder

Method Summary

Modifier and Type	Method	Description
static SmallRyeOpenAPI.Builder	builder()	Create a new SmallRyeOpenAPI.Builder instance;
org.eclipse.microprofile.openapi.models.OpenAPI	model()	The final OpenAPI model generated from SmallRyeOpenAPI.Builder.build().
String	toJSON()	Serializes the model as a JSON String
String	toYAML()	Serializes the model as a YAML String

Methods inherited from class java.lang.Object

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

Method Details

model

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

The final OpenAPI model generated from SmallRyeOpenAPI.Builder.build().

toJSON

public String toJSON()

Serializes the model as a JSON String

toYAML

public String toYAML()

Serializes the model as a YAML String

builder

public static SmallRyeOpenAPI.Builder builder()

Create a new SmallRyeOpenAPI.Builder instance;

Returns:

a new SmallRyeOpenAPI.Builder