Class ExampleBuilderBaseAbstract

ExampleBuilder generates examples from OpenAPIV3.ReferenceObject of OpenAPIV3.SchemaObject with auto detect examples, default value, enum value

if value has example it returns example

if value has default type instead example it returns default value

if value is enum, it returns first possible value

if value is integer returns 0

if value is boolean returns false

if value is string returns "string"

Hierarchy

Constructors

constructor

Properties

_options?

Methods

_buildObj _genJsonString _getSchemaObj build

Constructors

constructor

Properties

Protected Optional _options

_options?: IRavageOptions

Methods

Protected Abstract _buildObj

  • _buildObj(obj, openapi): Promise<object>

  • Build example with object type with recursive DFS algorithm on graph with nodes OpenAPIV3.ReferenceObject or OpenAPIV3.SchemaObject

    Parameters

    Returns Promise<object>

Protected Abstract _genJsonString

  • _genJsonString(obj, openapi): Promise<string>

  • Generates JSON string with indent for Content block example

    Parameters

    Returns Promise<string>

Protected Abstract _getSchemaObj

  • _getSchemaObj(obj, openapi): Promise<SchemaObject>

  • Get schema from openapi.components.schemas, if obj is OpenAPIV3.SchemaObject it returns obj, otherwise it search OpenAPIV3.SchemaObject

    Parameters

    Returns Promise<SchemaObject>

Abstract build

  • Build example and returns Content block with indent

    Parameters

    Returns Promise<Content>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc