cn.torna.swaggerplugin.builder

Class ApiDocBuilder

java.lang.Object

cn.torna.swaggerplugin.builder.ApiDocBuilder

public class ApiDocBuilder
extends Object

解析文档信息

Author:

tanghc

Constructor Summary

Constructors

Constructor and Description
ApiDocBuilder()
ApiDocBuilder(Map<String,Class<?>> genericParamMap, TornaConfig tornaConfig)

Method Summary

Modifier and Type	Method and Description
protected void	bindJarClassFields(Class<?> targetClass, List<FieldDocInfo> fieldDocInfos)
protected FieldDocInfo	buildFieldDocInfo(io.swagger.annotations.ApiModelProperty apiModelProperty, Field field, Type generic)
List<FieldDocInfo>	buildFieldDocInfo(Class<?> paramClass) 生成文档信息
protected FieldDocInfo	buildFieldDocInfoByClass(io.swagger.annotations.ApiModelProperty apiModelProperty, Class<?> clazz, Field field)
protected FieldDocInfo	buildFieldDocInfoByEnumClass(Class<Enum> enumClass, io.swagger.annotations.ApiModelProperty apiModelProperty, Field field)
protected List<FieldDocInfo>	buildFieldDocInfosByType(Class<?> clazz, boolean root, Class<?> generic) 从api参数中构建
protected void	formatDataType(FieldDocInfo fieldDocInfo, Class<?> fieldType)
protected Class<?>	getCollectionElementClass(Class<?> clazz)
protected Class<?>	getGenericParamClass(Class<?> clazz, String name)
protected boolean	isCycle(Class<?> clazz, Field field)
protected boolean	isObjectClass(Class<?> targetClass)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiDocBuilder

public ApiDocBuilder()

ApiDocBuilder

public ApiDocBuilder(Map<String,Class<?>> genericParamMap,
                     TornaConfig tornaConfig)

Method Detail

buildFieldDocInfo

public List<FieldDocInfo> buildFieldDocInfo(Class<?> paramClass)

生成文档信息

Parameters:

paramClass - 参数类型

Returns:

返回文档内容

buildFieldDocInfosByType

protected List<FieldDocInfo> buildFieldDocInfosByType(Class<?> clazz,
                                                      boolean root,
                                                      Class<?> generic)

从api参数中构建

formatDataType

protected void formatDataType(FieldDocInfo fieldDocInfo,
                              Class<?> fieldType)

isObjectClass

protected boolean isObjectClass(Class<?> targetClass)

bindJarClassFields

protected void bindJarClassFields(Class<?> targetClass,
                                  List<FieldDocInfo> fieldDocInfos)

getCollectionElementClass

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

buildFieldDocInfo

protected FieldDocInfo buildFieldDocInfo(io.swagger.annotations.ApiModelProperty apiModelProperty,
                                         Field field,
                                         Type generic)

getGenericParamClass

protected Class<?> getGenericParamClass(Class<?> clazz,
                                        String name)

buildFieldDocInfoByClass

protected FieldDocInfo buildFieldDocInfoByClass(io.swagger.annotations.ApiModelProperty apiModelProperty,
                                                Class<?> clazz,
                                                Field field)

buildFieldDocInfoByEnumClass

protected FieldDocInfo buildFieldDocInfoByEnumClass(Class<Enum> enumClass,
                                                    io.swagger.annotations.ApiModelProperty apiModelProperty,
                                                    Field field)

isCycle

protected boolean isCycle(Class<?> clazz,
                          Field field)