io.apicurio.datamodels

Class Library

java.lang.Object

io.apicurio.datamodels.Library

public class Library
extends Object

The most common entry points into using the data models library. Provides convenience methods for performing common actions such as i/o, visiting, and validation.

Author:

eric.wittmann@gmail.com, Jakub Senko

Constructor Summary

Constructors

Constructor and Description
Library()

Method Summary

Modifier and Type	Method and Description
static Document	cloneDocument(Document source) Clones the given document by serializing it to a JS object, and then re-parsing it.
static Document	createDocument(DocumentType type) Creates a new, empty document of the given type.
static NodePath	createNodePath(Node node) Called to create a node path for a given data model node.
static DocumentType	discoverDocumentType(Object json) Called to discover what type of document the given JSON data represents.
static Document	readDocument(Object json) Reads an entire document from JSON data.
static Document	readDocumentFromJSONString(String jsonString) Reads an entire document from a JSON formatted string.
static Node	readNode(Object json, Node node) Call this to do a "partial read" on a given node.
static Oas30Document	transformDocument(Oas20Document source) Transforms from an OpenAPI 2.0 document into a 3.0 document.
static List<ValidationProblem>	validate(Node node, IValidationSeverityRegistry severityRegistry) Called to validate a data model node.
static void	visitNode(Node node, IVisitor visitor) Convenience method for visiting a single data model nodel.
static void	visitTree(Node node, IVisitor visitor, TraverserDirection direction) Convenience method for visiting a data model tree.
static String	writeDocumentToJSONString(Document document) Called to serialize a given data model to a JSON formatted string.
static Object	writeNode(Node node) Called to serialize a given data model node to a JSON object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Library

public Library()

Method Detail

createDocument

public static Document createDocument(DocumentType type)

Creates a new, empty document of the given type.

Parameters:

type -

createNodePath

public static NodePath createNodePath(Node node)

Called to create a node path for a given data model node.

Parameters:

node -

visitNode

public static void visitNode(Node node,
                             IVisitor visitor)

Convenience method for visiting a single data model nodel.

Parameters:

node -

visitor -

visitTree

public static void visitTree(Node node,
                             IVisitor visitor,
                             TraverserDirection direction)

Convenience method for visiting a data model tree. Supports traversing the data model either up or down the tree.

Parameters:

node -

visitor -

direction -

validate

public static List<ValidationProblem> validate(Node node,
                                               IValidationSeverityRegistry severityRegistry)

Called to validate a data model node. All validation rules will be evaluated and reported. The list of validation problems found during validation is returned. In addition, validation problems will be reported on the individual nodes themselves. Validation problem severity is determined by checking with the included severity registry. If the severity registry is null, a default registry is used.

Parameters:

node -

severityRegistry -

readDocument

public static Document readDocument(Object json)

Reads an entire document from JSON data. The JSON data (already parsed, not in string format) is read as a data model Document and returned.

Parameters:

json -

readDocumentFromJSONString

public static Document readDocumentFromJSONString(String jsonString)

Reads an entire document from a JSON formatted string. This will parse the given string into JSON data and then call Library.readDocument.

Parameters:

jsonString -

readNode

public static Node readNode(Object json,
                            Node node)

Call this to do a "partial read" on a given node. You must pass the JSON data for the node type and an empty instance of the property node class. For example, you could read just an Operation by passing the JSON data for the operation along with an instance of e.g. Oas30Operation and this will read the data and store it in the instance.

Parameters:

json -

node -

writeNode

public static Object writeNode(Node node)

Called to serialize a given data model node to a JSON object.

Parameters:

node -

writeDocumentToJSONString

public static String writeDocumentToJSONString(Document document)

Called to serialize a given data model to a JSON formatted string.

Parameters:

document -

discoverDocumentType

public static DocumentType discoverDocumentType(Object json)

Called to discover what type of document the given JSON data represents. This method interrogates the following appropriate top level properties: - asyncapi - openapi - swagger Based on which property is defined, and the value of that property, the correct document type is determined and returned.

Parameters:

json -

cloneDocument

public static Document cloneDocument(Document source)

Clones the given document by serializing it to a JS object, and then re-parsing it.

Parameters:

source -

transformDocument

public static Oas30Document transformDocument(Oas20Document source)

Transforms from an OpenAPI 2.0 document into a 3.0 document.

Parameters:

source -