Package org.openapitools.codegen.utils

Class URLPathUtils

java.lang.Object

org.openapitools.codegen.utils.URLPathUtils

public class URLPathUtils
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static String	LOCAL_HOST
static Pattern	VARIABLE_PATTERN

Constructor Summary

Constructors

Constructor	Description
URLPathUtils()

Method Summary

Modifier and Type	Method	Description
static String	getHost(io.swagger.v3.oas.models.OpenAPI openAPI, Map<String,String> userDefinedVariables)	Return the first complete URL from the OpenAPI specification
static String	getPath(URL url, String defaultPath)	Return the path, example value /abcdef/xyz
static String	getPort(URL url, int defaultPort)	Return the port, example value 8080
static String	getPort(URL url, String defaultPort)	Return the port, example value 8080
static String	getProtocolAndHost(URL url)	Get the protocol and the host, example value https://www.abcdef.xyz
static String	getScheme(io.swagger.v3.oas.models.OpenAPI openAPI, CodegenConfig config)
static String	getScheme(URL url, CodegenConfig config)
static URL	getServerURL(io.swagger.v3.oas.models.OpenAPI openAPI, Map<String,String> userDefinedVariables)
static URL	getServerURL(io.swagger.v3.oas.models.servers.Server server, Map<String,String> userDefinedVariables)
static boolean	isRelativeUrl(List<io.swagger.v3.oas.models.servers.Server> servers)

Methods inherited from class java.lang.Object

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

Field Detail

LOCAL_HOST

public static final String LOCAL_HOST

See Also:

Constant Field Values

VARIABLE_PATTERN

public static final Pattern VARIABLE_PATTERN

Constructor Detail

URLPathUtils

public URLPathUtils()

Method Detail

getServerURL

public static URL getServerURL(io.swagger.v3.oas.models.OpenAPI openAPI,
                               Map<String,String> userDefinedVariables)

getServerURL

public static URL getServerURL(io.swagger.v3.oas.models.servers.Server server,
                               Map<String,String> userDefinedVariables)

getScheme

public static String getScheme(io.swagger.v3.oas.models.OpenAPI openAPI,
                               CodegenConfig config)

getScheme

public static String getScheme(URL url,
                               CodegenConfig config)

getPort

public static String getPort(URL url,
                             int defaultPort)

Return the port, example value 8080

Parameters:

url - server url

defaultPort - if the port is not set

Returns:

port

getPort

public static String getPort(URL url,
                             String defaultPort)

Return the port, example value 8080

Parameters:

url - server url

defaultPort - if the port is not set

Returns:

port

getPath

public static String getPath(URL url,
                             String defaultPath)

Return the path, example value /abcdef/xyz

Parameters:

url - server url

defaultPath - if the path is not empty

Returns:

path

getProtocolAndHost

public static String getProtocolAndHost(URL url)

Get the protocol and the host, example value https://www.abcdef.xyz

Parameters:

url - server url

Returns:

protocolAndHost

getHost

public static String getHost(io.swagger.v3.oas.models.OpenAPI openAPI,
                             Map<String,String> userDefinedVariables)

Return the first complete URL from the OpenAPI specification

Parameters:

openAPI - current OpenAPI specification

userDefinedVariables - User overrides for server variable templating

Returns:

host

isRelativeUrl

public static boolean isRelativeUrl(List<io.swagger.v3.oas.models.servers.Server> servers)