Package io.swagger.v3.parser

Class OpenAPIV3Parser

java.lang.Object

io.swagger.v3.parser.OpenAPIV3Parser

All Implemented Interfaces:

io.swagger.v3.parser.core.extensions.SwaggerParserExtension

public class OpenAPIV3Parser
extends Object
implements io.swagger.v3.parser.core.extensions.SwaggerParserExtension

Field Summary

Fields

Modifier and Type	Field	Description
static String	DISABLE_OAS31_RESOLVE

Constructor Summary

Constructors

Constructor	Description
OpenAPIV3Parser()

Method Summary

Modifier and Type	Method	Description
static String	getEncoding()
static List<io.swagger.v3.parser.core.extensions.SwaggerParserExtension>	getExtensions()	Locates extensions on the current thread class loader and then, if it differs from this class classloader (as in OSGi), locates extensions from this class classloader as well.
protected static List<io.swagger.v3.parser.core.extensions.SwaggerParserExtension>	getExtensions(ClassLoader cl)
io.swagger.v3.parser.core.models.SwaggerParseResult	parseJsonNode(String path, com.fasterxml.jackson.databind.JsonNode node)
io.swagger.v3.parser.core.models.SwaggerParseResult	parseJsonNode(String path, com.fasterxml.jackson.databind.JsonNode node, io.swagger.v3.parser.core.models.ParseOptions options)
io.swagger.v3.oas.models.OpenAPI	read(String location)
io.swagger.v3.oas.models.OpenAPI	read(String location, List<io.swagger.v3.parser.core.models.AuthorizationValue> auths, io.swagger.v3.parser.core.models.ParseOptions resolve)
io.swagger.v3.parser.core.models.SwaggerParseResult	readContents(String yaml)
io.swagger.v3.parser.core.models.SwaggerParseResult	readContents(String swaggerAsString, List<io.swagger.v3.parser.core.models.AuthorizationValue> auth, io.swagger.v3.parser.core.models.ParseOptions options)
io.swagger.v3.parser.core.models.SwaggerParseResult	readContents(String swaggerAsString, List<io.swagger.v3.parser.core.models.AuthorizationValue> auth, io.swagger.v3.parser.core.models.ParseOptions options, String location)
io.swagger.v3.parser.core.models.SwaggerParseResult	readLocation(String url, List<io.swagger.v3.parser.core.models.AuthorizationValue> auth, io.swagger.v3.parser.core.models.ParseOptions options)
io.swagger.v3.parser.core.models.SwaggerParseResult	readWithInfo(String path, com.fasterxml.jackson.databind.JsonNode node)	Deprecated.
io.swagger.v3.parser.core.models.SwaggerParseResult	readWithInfo(String location, List<io.swagger.v3.parser.core.models.AuthorizationValue> auths)	Deprecated.
static void	setEncoding(String encoding)
protected List<io.swagger.v3.parser.core.models.AuthorizationValue>	transform(List<io.swagger.v3.parser.core.models.AuthorizationValue> input)	Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

DISABLE_OAS31_RESOLVE

public static final String DISABLE_OAS31_RESOLVE

See Also:

Constant Field Values

Constructor Detail

OpenAPIV3Parser

public OpenAPIV3Parser()

Method Detail

getExtensions

public static List<io.swagger.v3.parser.core.extensions.SwaggerParserExtension> getExtensions()

Locates extensions on the current thread class loader and then, if it differs from this class classloader (as in OSGi), locates extensions from this class classloader as well.

Returns:

a list of extensions

getExtensions

protected static List<io.swagger.v3.parser.core.extensions.SwaggerParserExtension> getExtensions(ClassLoader cl)

getEncoding

public static String getEncoding()

setEncoding

public static void setEncoding(String encoding)

readLocation

public io.swagger.v3.parser.core.models.SwaggerParseResult readLocation(String url,
                                                                        List<io.swagger.v3.parser.core.models.AuthorizationValue> auth,
                                                                        io.swagger.v3.parser.core.models.ParseOptions options)

Specified by:

readLocation in interface io.swagger.v3.parser.core.extensions.SwaggerParserExtension

readContents

public io.swagger.v3.parser.core.models.SwaggerParseResult readContents(String swaggerAsString,
                                                                        List<io.swagger.v3.parser.core.models.AuthorizationValue> auth,
                                                                        io.swagger.v3.parser.core.models.ParseOptions options)

Specified by:

readContents in interface io.swagger.v3.parser.core.extensions.SwaggerParserExtension

read

public io.swagger.v3.oas.models.OpenAPI read(String location)

read

public io.swagger.v3.oas.models.OpenAPI read(String location,
                                             List<io.swagger.v3.parser.core.models.AuthorizationValue> auths,
                                             io.swagger.v3.parser.core.models.ParseOptions resolve)

readWithInfo

@Deprecated
public io.swagger.v3.parser.core.models.SwaggerParseResult readWithInfo(String path,
                                                                        com.fasterxml.jackson.databind.JsonNode node)

Deprecated.

parseJsonNode

public io.swagger.v3.parser.core.models.SwaggerParseResult parseJsonNode(String path,
                                                                         com.fasterxml.jackson.databind.JsonNode node)

parseJsonNode

public io.swagger.v3.parser.core.models.SwaggerParseResult parseJsonNode(String path,
                                                                         com.fasterxml.jackson.databind.JsonNode node,
                                                                         io.swagger.v3.parser.core.models.ParseOptions options)

readContents

public io.swagger.v3.parser.core.models.SwaggerParseResult readContents(String yaml)

readContents

public io.swagger.v3.parser.core.models.SwaggerParseResult readContents(String swaggerAsString,
                                                                        List<io.swagger.v3.parser.core.models.AuthorizationValue> auth,
                                                                        io.swagger.v3.parser.core.models.ParseOptions options,
                                                                        String location)

readWithInfo

@Deprecated
public io.swagger.v3.parser.core.models.SwaggerParseResult readWithInfo(String location,
                                                                        List<io.swagger.v3.parser.core.models.AuthorizationValue> auths)

Deprecated.

transform

@Deprecated
protected List<io.swagger.v3.parser.core.models.AuthorizationValue> transform(List<io.swagger.v3.parser.core.models.AuthorizationValue> input)

Deprecated.

Transform the swagger-model version of AuthorizationValue into a parser-specific one, to avoid dependencies across extensions

Parameters:

input -

Returns: