Class OpenApiRenderer

java.lang.Object

io.fluxzero.sdk.web.OpenApiRenderer

public final class OpenApiRenderer
extends Object

Renders a generic ApiDocCatalog as an OpenAPI JSON document.

The renderer intentionally uses a small inline schema generator instead of binding the SDK API to an OpenAPI-specific model library. The generated schemas cover common Java primitives, enums, records, arrays, collections, maps, and simple field-based POJOs. Validation annotations on map values are retained. String-compatible map-key constraints are rendered as propertyNames in OpenAPI 3.1 and omitted in OpenAPI 3.0, where that keyword is unsupported. Required metadata on a body or body/form parameter also marks the OpenAPI Request Body Object as required.

See Also:

• OpenApiProcessor

Method Summary

Modifier and Type	Method	Description
static com.fasterxml.jackson.databind.node.ObjectNode	render(ApiDocCatalog catalog)
static com.fasterxml.jackson.databind.node.ObjectNode	render(ApiDocCatalog catalog, OpenApiOptions options)
static String	renderJson(ApiDocCatalog catalog)
static String	renderJson(ApiDocCatalog catalog, OpenApiOptions options)
static String	renderPrettyJson(ApiDocCatalog catalog, OpenApiOptions options)

Methods inherited from class Object

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

Method Details

render

public static com.fasterxml.jackson.databind.node.ObjectNode render(ApiDocCatalog catalog)

render

public static com.fasterxml.jackson.databind.node.ObjectNode render(ApiDocCatalog catalog,
 OpenApiOptions options)

renderJson

public static String renderJson(ApiDocCatalog catalog)

renderJson

public static String renderJson(ApiDocCatalog catalog,
 OpenApiOptions options)

renderPrettyJson

public static String renderPrettyJson(ApiDocCatalog catalog,
 OpenApiOptions options)