程序包 com.github.xiaoymin.knife4j.aggre.core

类 RouteDispatcher

java.lang.Object

com.github.xiaoymin.knife4j.aggre.core.RouteDispatcher

public class RouteDispatcher
extends Object

从以下版本开始:

2.0.8

作者:

xiaoymin@foxmail.com 2020/10/29 20:08

字段概要

字段

修饰符和类型	字段	说明
static final String	OPENAPI_GROUP_ENDPOINT
static final String	OPENAPI_GROUP_INSTANCE_ENDPOINT
static final String	OPENAPI3_GROUP_ENDPOINT
static final String	ROUTE_BASE_PATH
static final String	ROUTE_PROXY_HEADER_BASIC_NAME
static final String	ROUTE_PROXY_HEADER_NAME	header

构造器概要

构造器

构造器	说明
RouteDispatcher(RouteRepository routeRepository, RouteCache<String,SwaggerRoute> routeRouteCache, ExecutorEnum executorEnum, String rootPath, OpenAPIV3Setting openAPIV3Setting)

方法概要

修饰符和类型	方法	说明
protected void	buildContext(RouteRequestContext routeRequestContext, jakarta.servlet.http.HttpServletRequest request)	Build Context of Route
boolean	checkRoute(String header)
void	execute(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
OpenAPI3Response	getOpenAPI3Response(jakarta.servlet.http.HttpServletRequest request)	convert openapi2 to openapi3
String	getRootPath()
SwaggerRoute	getRoute(String header)
List<SwaggerRoute>	getRoutes()
protected void	writeBody(RouteResponse routeResponse, jakarta.servlet.http.HttpServletResponse response)	Write Body
protected void	writeDefault(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, String errMsg)
protected void	writeResponseHeader(RouteResponse routeResponse, jakarta.servlet.http.HttpServletResponse response)	Write Response Header
protected void	writeResponseStatus(RouteResponse routeResponse, jakarta.servlet.http.HttpServletResponse response)	Write Http Status Code

从类继承的方法 java.lang.Object

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

字段详细资料

ROUTE_PROXY_HEADER_NAME

public static final String ROUTE_PROXY_HEADER_NAME

header

另请参阅:

• 常量字段值

ROUTE_PROXY_HEADER_BASIC_NAME

public static final String ROUTE_PROXY_HEADER_BASIC_NAME

另请参阅:

• 常量字段值

OPENAPI3_GROUP_ENDPOINT

public static final String OPENAPI3_GROUP_ENDPOINT

另请参阅:

• 常量字段值

OPENAPI_GROUP_ENDPOINT

public static final String OPENAPI_GROUP_ENDPOINT

另请参阅:

• 常量字段值

OPENAPI_GROUP_INSTANCE_ENDPOINT

public static final String OPENAPI_GROUP_INSTANCE_ENDPOINT

另请参阅:

• 常量字段值

ROUTE_BASE_PATH

public static final String ROUTE_BASE_PATH

另请参阅:

• 常量字段值

构造器详细资料

RouteDispatcher

public RouteDispatcher(RouteRepository routeRepository,
 RouteCache<String,SwaggerRoute> routeRouteCache,
 ExecutorEnum executorEnum,
 String rootPath,
 OpenAPIV3Setting openAPIV3Setting)

方法详细资料

checkRoute

public boolean checkRoute(String header)

execute

public void execute(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)

writeDefault

protected void writeDefault(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 String errMsg)

writeResponseStatus

protected void writeResponseStatus(RouteResponse routeResponse,
 jakarta.servlet.http.HttpServletResponse response)

Write Http Status Code

参数:

routeResponse - routeResponse

response - response

writeResponseHeader

protected void writeResponseHeader(RouteResponse routeResponse,
 jakarta.servlet.http.HttpServletResponse response)

Write Response Header

参数:

routeResponse - route instance

response - Servlet Response

writeBody

protected void writeBody(RouteResponse routeResponse,
 jakarta.servlet.http.HttpServletResponse response)
                  throws IOException

Write Body

参数:

routeResponse - route

response - Servlet Response

抛出:

IOException

buildContext

protected void buildContext(RouteRequestContext routeRequestContext,
 jakarta.servlet.http.HttpServletRequest request)
                     throws IOException

Build Context of Route

参数:

routeRequestContext - Route Context

request - Servlet Request

抛出:

IOException

getRoute

public SwaggerRoute getRoute(String header)

getRoutes

public List<SwaggerRoute> getRoutes()

getOpenAPI3Response

public OpenAPI3Response getOpenAPI3Response(jakarta.servlet.http.HttpServletRequest request)

convert openapi2 to openapi3

返回:

getRootPath

public String getRootPath()