cn.torna.swaggerplugin

Class SwaggerPluginService

java.lang.Object

cn.torna.swaggerplugin.SwaggerPluginService

public class SwaggerPluginService
extends Object

Author:

tanghc

Constructor Summary

Constructors

Constructor and Description
SwaggerPluginService(TornaConfig tornaConfig)

Method Summary

Modifier and Type	Method and Description
protected List<io.swagger.annotations.ApiImplicitParam>	buildApiImplicitParams(Method method, cn.torna.swaggerplugin.SwaggerPluginService.ParamFilter filter)
protected String	buildAuthor(io.swagger.annotations.ApiOperation apiOperation)
protected List<cn.torna.sdk.param.DebugEnv>	buildDebugEnvs()
protected cn.torna.sdk.param.DocItem	buildDocItem(RequestInfoBuilder requestInfoBuilder)
protected cn.torna.sdk.param.DocParamReq	buildDocParamReq(Parameter parameter)
protected List<cn.torna.sdk.param.DocParamCode>	buildErrorCodes(io.swagger.annotations.ApiOperation apiOperation)
protected List<cn.torna.sdk.param.DocParamHeader>	buildHeaderParams(Method method)
protected int	buildOrder(io.swagger.annotations.ApiOperation apiOperation, Method method)
protected Map<String,Class<?>>	buildParamsByGeneric(Type genericParameterType)
protected List<cn.torna.sdk.param.DocParamPath>	buildPathParams(Method method)
protected List<cn.torna.sdk.param.DocParamReq>	buildQueryParams(Method method, String httpMethod)
protected List<cn.torna.sdk.param.DocParamReq>	buildReqClassParams(Class<?> clazz)
protected List<cn.torna.sdk.param.DocParamReq>	buildReqClassParams(Map<String,Class<?>> genericParamMap, Class<?> clazz)
protected cn.torna.swaggerplugin.SwaggerPluginService.DocParamReqWrapper	buildRequestParams(Method method, String httpMethod)
protected List<cn.torna.sdk.param.DocParamResp>	buildRespClassParams(Map<String,Class<?>> genericParamMap, Class<?> clazz)
protected cn.torna.swaggerplugin.SwaggerPluginService.DocParamRespWrapper	buildResponseParams(Method method)
protected cn.torna.sdk.param.DocItem	doBuildDocItem(RequestInfoBuilder requestInfoBuilder)
protected void	doPush()
protected List<io.swagger.annotations.ExtensionProperty>	filterExtension(io.swagger.annotations.ApiOperation apiOperation, String name)
protected void	formatDocParamReqIndex(List<cn.torna.sdk.param.DocParamReq> docParamReqs)
protected void	formatDocParamRespIndex(List<cn.torna.sdk.param.DocParamResp> docParamReqs)
protected void	formatIndex(List<cn.torna.sdk.param.DocItem> docItems)
protected String	getArrayElementType(ApiParamWrapper apiParamWrapper, Class<?> type, Type genericParameterType)
protected Class<?>	getClassFromArrayType(Class<?> clazz)
protected String	getDataType(io.swagger.annotations.ApiImplicitParam apiImplicitParam)
protected String	getParameterName(Parameter parameter) 获取参数名称
protected List<String>	getTags(io.swagger.annotations.Api api)
TornaConfig	getTornaConfig()
protected boolean	isBodyParameter(Parameter parameter, String httpMethod) 是否body体参数
protected boolean	isIgnoreParameter(Parameter parameter)
boolean	match(Method method)
protected void	push(List<cn.torna.sdk.param.DocItem> docItems)
protected void	pushCode() 推送错误码
void	pushDoc()

Methods inherited from class java.lang.Object

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

Constructor Detail

SwaggerPluginService

public SwaggerPluginService(TornaConfig tornaConfig)

Method Detail

pushDoc

public void pushDoc()

doPush

protected void doPush()

pushCode

protected void pushCode()

推送错误码

push

protected void push(List<cn.torna.sdk.param.DocItem> docItems)

formatIndex

protected void formatIndex(List<cn.torna.sdk.param.DocItem> docItems)

formatDocParamReqIndex

protected void formatDocParamReqIndex(List<cn.torna.sdk.param.DocParamReq> docParamReqs)

formatDocParamRespIndex

protected void formatDocParamRespIndex(List<cn.torna.sdk.param.DocParamResp> docParamReqs)

buildDebugEnvs

protected List<cn.torna.sdk.param.DebugEnv> buildDebugEnvs()

buildDocItem

protected cn.torna.sdk.param.DocItem buildDocItem(RequestInfoBuilder requestInfoBuilder)
                                           throws HiddenException,
                                                  IgnoreException

Throws:

HiddenException

IgnoreException

doBuildDocItem

protected cn.torna.sdk.param.DocItem doBuildDocItem(RequestInfoBuilder requestInfoBuilder)

buildOrder

protected int buildOrder(io.swagger.annotations.ApiOperation apiOperation,
                         Method method)

buildAuthor

protected String buildAuthor(io.swagger.annotations.ApiOperation apiOperation)

isIgnoreParameter

protected boolean isIgnoreParameter(Parameter parameter)

buildPathParams

protected List<cn.torna.sdk.param.DocParamPath> buildPathParams(Method method)

buildHeaderParams

protected List<cn.torna.sdk.param.DocParamHeader> buildHeaderParams(Method method)

buildQueryParams

protected List<cn.torna.sdk.param.DocParamReq> buildQueryParams(Method method,
                                                                String httpMethod)

buildDocParamReq

protected cn.torna.sdk.param.DocParamReq buildDocParamReq(Parameter parameter)

getParameterName

protected String getParameterName(Parameter parameter)

获取参数名称

Parameters:

parameter - 参数

Returns:

返回参数名称

buildRequestParams

protected cn.torna.swaggerplugin.SwaggerPluginService.DocParamReqWrapper buildRequestParams(Method method,
                                                                                            String httpMethod)

isBodyParameter

protected boolean isBodyParameter(Parameter parameter,
                                  String httpMethod)

是否body体参数

Parameters:

parameter - 参数

httpMethod - 请求方法

Returns:

true：是body参数

buildResponseParams

protected cn.torna.swaggerplugin.SwaggerPluginService.DocParamRespWrapper buildResponseParams(Method method)

getArrayElementType

protected String getArrayElementType(ApiParamWrapper apiParamWrapper,
                                     Class<?> type,
                                     Type genericParameterType)

buildParamsByGeneric

protected Map<String,Class<?>> buildParamsByGeneric(Type genericParameterType)

buildErrorCodes

protected List<cn.torna.sdk.param.DocParamCode> buildErrorCodes(io.swagger.annotations.ApiOperation apiOperation)

filterExtension

protected List<io.swagger.annotations.ExtensionProperty> filterExtension(io.swagger.annotations.ApiOperation apiOperation,
                                                                         String name)

buildReqClassParams

protected List<cn.torna.sdk.param.DocParamReq> buildReqClassParams(Class<?> clazz)

buildReqClassParams

protected List<cn.torna.sdk.param.DocParamReq> buildReqClassParams(Map<String,Class<?>> genericParamMap,
                                                                   Class<?> clazz)

buildRespClassParams

protected List<cn.torna.sdk.param.DocParamResp> buildRespClassParams(Map<String,Class<?>> genericParamMap,
                                                                     Class<?> clazz)

getClassFromArrayType

protected Class<?> getClassFromArrayType(Class<?> clazz)

getDataType

protected String getDataType(io.swagger.annotations.ApiImplicitParam apiImplicitParam)

buildApiImplicitParams

protected List<io.swagger.annotations.ApiImplicitParam> buildApiImplicitParams(Method method,
                                                                               cn.torna.swaggerplugin.SwaggerPluginService.ParamFilter filter)

getTags

protected List<String> getTags(io.swagger.annotations.Api api)

getTornaConfig

public TornaConfig getTornaConfig()

match

public boolean match(Method method)