org.wildfly.swarm.microprofile.openapi.runtime.io

Class OpenApiParser

java.lang.Object

org.wildfly.swarm.microprofile.openapi.runtime.io.OpenApiParser

public class OpenApiParser
extends Object

A class used to parse an OpenAPI document (either YAML or JSON) into a Microprofile OpenAPI model tree.

Author:

eric.wittmann@gmail.com

Constructor Summary

Constructors

Constructor and Description
OpenApiParser(com.fasterxml.jackson.databind.JsonNode tree) Constructor.

Method Summary

Modifier and Type	Method and Description
static OpenAPIImpl	parse(InputStream stream, OpenApiSerializer.Format format) Parses the resource found at the given stream.
static OpenAPIImpl	parse(URL url) Parses the resource found at the given URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenApiParser

public OpenApiParser(com.fasterxml.jackson.databind.JsonNode tree)

Constructor.

Parameters:

tree -

Method Detail

parse

public static final OpenAPIImpl parse(URL url)
                               throws IOException,
                                      ParseException

Parses the resource found at the given URL. This method accepts resources either in JSON or YAML format. It will parse the input and, assuming it is valid, return an instance of OpenAPI.

Parameters:

url -

Throws:

IOException

ParseException

parse

public static final OpenAPIImpl parse(InputStream stream,
                                      OpenApiSerializer.Format format)
                               throws IOException

Parses the resource found at the given stream. The format of the stream must be specified.

Parameters:

stream -

format -

Throws:

IOException