io.jboot.apidoc

类 ApiDocManager

java.lang.Object

io.jboot.apidoc.ApiDocManager

public class ApiDocManager
extends Object

字段概要

字段

限定符和类型	字段和说明
private Map<Class<?>,ApiMockBuilder>	classTypeMockBuilders
private Map<String,Object>	classTypeMockDatas
private Map<String,Map<String,String>>	defaultModelFieldRemarks
private static ApiDocManager	me
private Map<String,Map<String,String>>	modelFieldRemarks
private Comparator<ApiOperation>	operationComparator
private ApiDocRender	render

构造器概要

构造器

限定符	构造器和说明
private	ApiDocManager()

方法概要

限定符和类型	方法和说明
void	addClassTypeMockBuilders(Class<?> forClass, ApiMockBuilder builder)
void	addClassTypeMocks(String classType, Object mockData)
void	addModelFieldRemarks(String classOrSimpleName, Map<String,String> fieldNames)
private void	buildAllInOneDocument(ApiDocument document, List<Class> controllerClasses, ApiDocConfig config)
private ApiDocument	buildDocument(Class<?> controllerClass, ApiDocConfig config)
(专用程序包) String	buildMockJson(ClassType classType, Method method)
private void	buildOperation(ApiDocument document, Class<?> controllerClass, ApiDocConfig config)
(专用程序包) Map<String,List<ApiResponse>>	buildRemarks(ClassType classType, Method method)
(专用程序包) Object	doBuildMockObject(ClassType classType, Method method, int level)
private void	doBuildRemarks(Map<String,List<ApiResponse>> retMap, ClassType classType, Method method, int level)
private void	doBuildRemarksByConfig(Set<ApiResponse> apiResponses, ClassType classType, Method method1)
private void	doBuildRemarksByDefault(Set<ApiResponse> apiResponses, ClassType classType, Method method1)
private List<Class<?>>	doBuildRemarksByMethodAnnotation(Set<ApiResponse> apiResponses, Method method)
void	genDocs(ApiDocConfig config) 生成 API 文档
Map<Class<?>,ApiMockBuilder>	getClassTypeMockBuilders()
Object	getClassTypeMockData(String classType)
Map<String,Object>	getClassTypeMockDatas()
private Map<String,String>	getConfigRemarks(Class<?> clazz)
Map<String,Map<String,String>>	getModelFieldRemarks()
Comparator<ApiOperation>	getOperationComparator()
ApiDocRender	getRender()
private void	initDefaultClassTypeMockBuilder()
private void	initMockJson(ApiDocConfig config)
private void	initModelRemarks(ApiDocConfig config)
static ApiDocManager	me()
void	setClassTypeMockBuilders(Map<Class<?>,ApiMockBuilder> classTypeMockBuilders)
void	setClassTypeMockDatas(Map<String,Object> classTypeMockDatas)
void	setModelFieldRemarks(Map<String,Map<String,String>> modelFieldRemarks)
void	setOperationComparator(Comparator<ApiOperation> operationComparator)
void	setRender(ApiDocRender render)

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

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

字段详细资料

me

private static final ApiDocManager me

render

private ApiDocRender render

modelFieldRemarks

private Map<String,Map<String,String>> modelFieldRemarks

defaultModelFieldRemarks

private Map<String,Map<String,String>> defaultModelFieldRemarks

classTypeMockDatas

private Map<String,Object> classTypeMockDatas

classTypeMockBuilders

private Map<Class<?>,ApiMockBuilder> classTypeMockBuilders

operationComparator

private Comparator<ApiOperation> operationComparator

构造器详细资料

ApiDocManager

private ApiDocManager()

方法详细资料

me

public static ApiDocManager me()

initDefaultClassTypeMockBuilder

private void initDefaultClassTypeMockBuilder()

getRender

public ApiDocRender getRender()

setRender

public void setRender(ApiDocRender render)

getModelFieldRemarks

public Map<String,Map<String,String>> getModelFieldRemarks()

setModelFieldRemarks

public void setModelFieldRemarks(Map<String,Map<String,String>> modelFieldRemarks)

addModelFieldRemarks

public void addModelFieldRemarks(String classOrSimpleName,
                                 Map<String,String> fieldNames)

getClassTypeMockDatas

public Map<String,Object> getClassTypeMockDatas()

setClassTypeMockDatas

public void setClassTypeMockDatas(Map<String,Object> classTypeMockDatas)

addClassTypeMocks

public void addClassTypeMocks(String classType,
                              Object mockData)

getClassTypeMockData

public Object getClassTypeMockData(String classType)

getOperationComparator

public Comparator<ApiOperation> getOperationComparator()

setOperationComparator

public void setOperationComparator(Comparator<ApiOperation> operationComparator)

getClassTypeMockBuilders

public Map<Class<?>,ApiMockBuilder> getClassTypeMockBuilders()

setClassTypeMockBuilders

public void setClassTypeMockBuilders(Map<Class<?>,ApiMockBuilder> classTypeMockBuilders)

addClassTypeMockBuilders

public void addClassTypeMockBuilders(Class<?> forClass,
                                     ApiMockBuilder builder)

buildMockJson

String buildMockJson(ClassType classType,
                     Method method)

doBuildMockObject

Object doBuildMockObject(ClassType classType,
                         Method method,
                         int level)

buildRemarks

Map<String,List<ApiResponse>> buildRemarks(ClassType classType,
                                           Method method)

doBuildRemarks

private void doBuildRemarks(Map<String,List<ApiResponse>> retMap,
                            ClassType classType,
                            Method method,
                            int level)

doBuildRemarksByDefault

private void doBuildRemarksByDefault(Set<ApiResponse> apiResponses,
                                     ClassType classType,
                                     Method method1)

doBuildRemarksByMethodAnnotation

private List<Class<?>> doBuildRemarksByMethodAnnotation(Set<ApiResponse> apiResponses,
                                                        Method method)

doBuildRemarksByConfig

private void doBuildRemarksByConfig(Set<ApiResponse> apiResponses,
                                    ClassType classType,
                                    Method method1)

getConfigRemarks

private Map<String,String> getConfigRemarks(Class<?> clazz)

genDocs

public void genDocs(ApiDocConfig config)

生成 API 文档

参数:

config -

initMockJson

private void initMockJson(ApiDocConfig config)

initModelRemarks

private void initModelRemarks(ApiDocConfig config)

buildAllInOneDocument

private void buildAllInOneDocument(ApiDocument document,
                                   List<Class> controllerClasses,
                                   ApiDocConfig config)

buildDocument

private ApiDocument buildDocument(Class<?> controllerClass,
                                  ApiDocConfig config)

buildOperation

private void buildOperation(ApiDocument document,
                            Class<?> controllerClass,
                            ApiDocConfig config)