Package io.swagger.v3.parser.util

Class RefUtils

java.lang.Object

io.swagger.v3.parser.util.RefUtils

public class RefUtils
extends Object

Method Summary

Modifier and Type	Method	Description
static String	buildUrl(String rootPath, String relativePath)
static String	computeDefinitionName(String ref)
static RefFormat	computeRefFormat(String ref)
static Optional<String>	getExternalPath(String ref)
static boolean	isAnExternalRefFormat(RefFormat refFormat)
static String	mungedRef(String refString)
static String	readExternalClasspathRef(String file, RefFormat refFormat, List<io.swagger.v3.parser.core.models.AuthorizationValue> auths, String rootPath, io.swagger.v3.parser.urlresolver.PermittedUrlsChecker permittedUrlsChecker)
static String	readExternalRef(String file, RefFormat refFormat, List<io.swagger.v3.parser.core.models.AuthorizationValue> auths, Path parentDirectory)	Deprecated. - new readExternalRef with PermittedUrlsChecker is preferred because it prevents bypassing security checks
static String	readExternalRef(String file, RefFormat refFormat, List<io.swagger.v3.parser.core.models.AuthorizationValue> auths, Path parentDirectory, io.swagger.v3.parser.urlresolver.PermittedUrlsChecker permittedUrlsChecker)
static String	readExternalUrlRef(String file, RefFormat refFormat, List<io.swagger.v3.parser.core.models.AuthorizationValue> auths, String rootPath, io.swagger.v3.parser.urlresolver.PermittedUrlsChecker permittedUrlsChecker)

Methods inherited from class java.lang.Object

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

Method Detail

computeDefinitionName

public static String computeDefinitionName(String ref)

getExternalPath

public static Optional<String> getExternalPath(String ref)

isAnExternalRefFormat

public static boolean isAnExternalRefFormat(RefFormat refFormat)

computeRefFormat

public static RefFormat computeRefFormat(String ref)

mungedRef

public static String mungedRef(String refString)

readExternalUrlRef

public static String readExternalUrlRef(String file,
                                        RefFormat refFormat,
                                        List<io.swagger.v3.parser.core.models.AuthorizationValue> auths,
                                        String rootPath,
                                        io.swagger.v3.parser.urlresolver.PermittedUrlsChecker permittedUrlsChecker)

readExternalClasspathRef

public static String readExternalClasspathRef(String file,
                                              RefFormat refFormat,
                                              List<io.swagger.v3.parser.core.models.AuthorizationValue> auths,
                                              String rootPath,
                                              io.swagger.v3.parser.urlresolver.PermittedUrlsChecker permittedUrlsChecker)

buildUrl

public static String buildUrl(String rootPath,
                              String relativePath)

readExternalRef

@Deprecated
public static String readExternalRef(String file,
                                     RefFormat refFormat,
                                     List<io.swagger.v3.parser.core.models.AuthorizationValue> auths,
                                     Path parentDirectory)

Deprecated.

- new readExternalRef with PermittedUrlsChecker is preferred because it prevents bypassing security checks

readExternalRef

public static String readExternalRef(String file,
                                     RefFormat refFormat,
                                     List<io.swagger.v3.parser.core.models.AuthorizationValue> auths,
                                     Path parentDirectory,
                                     io.swagger.v3.parser.urlresolver.PermittedUrlsChecker permittedUrlsChecker)