public abstract class AbstractSpringJSONDocScanner extends AbstractJSONDocScanner
allApiMethodDocs, jsondocChangelogs, jsondocControllers, jsondocFlows, jsondocGlobal, jsondocMethods, jsondocMigrations, jsondocObjects, jsondocTemplates, log, reflections| Constructor and Description |
|---|
AbstractSpringJSONDocScanner() |
| Modifier and Type | Method and Description |
|---|---|
static Set<Class<?>> |
buildJSONDocObjectsCandidates(Set<Class<?>> candidates,
Class<?> clazz,
Type type,
org.reflections.Reflections reflections)
Returns a set of classes that are either return types or body objects
|
ApiDoc |
initApiDoc(Class<?> controller)
ApiDoc is initialized with the Controller's simple class name.
|
ApiMethodDoc |
initApiMethodDoc(Method method,
Map<Class<?>,JSONDocTemplate> jsondocTemplates) |
ApiObjectDoc |
initApiObjectDoc(Class<?> clazz) |
Set<Class<?>> |
jsondocChangelogs() |
Set<Class<?>> |
jsondocFlows() |
Set<Class<?>> |
jsondocGlobal() |
Set<Method> |
jsondocMethods(Class<?> controller) |
Set<Class<?>> |
jsondocMigrations() |
Set<Class<?>> |
jsondocObjects(List<String> packages) |
ApiDoc |
mergeApiDoc(Class<?> controller,
ApiDoc apiDoc)
Once the ApiDoc has been initialized and filled with other data (version,
auth, etc) it's time to merge the documentation with JSONDoc annotation,
if existing.
|
ApiMethodDoc |
mergeApiMethodDoc(Method method,
ApiMethodDoc apiMethodDoc) |
ApiObjectDoc |
mergeApiObjectDoc(Class<?> clazz,
ApiObjectDoc apiObjectDoc) |
enumConstantsToStringArray, getApiDocs, getApiDocsMap, getApiFlowDocs, getApiFlowDocsMap, getApiGlobalDoc, getApiObjectDocs, getApiObjectsMap, getJSONDoc, jsondocControllerspublic Set<Method> jsondocMethods(Class<?> controller)
jsondocMethods in class AbstractJSONDocScannerpublic static Set<Class<?>> buildJSONDocObjectsCandidates(Set<Class<?>> candidates, Class<?> clazz, Type type, org.reflections.Reflections reflections)
candidates - clazz - type - reflections - public Set<Class<?>> jsondocObjects(List<String> packages)
jsondocObjects in class AbstractJSONDocScannerpublic Set<Class<?>> jsondocFlows()
jsondocFlows in class AbstractJSONDocScannerpublic ApiDoc initApiDoc(Class<?> controller)
initApiDoc in class AbstractJSONDocScannerpublic ApiDoc mergeApiDoc(Class<?> controller, ApiDoc apiDoc)
mergeApiDoc in class AbstractJSONDocScannerpublic ApiMethodDoc initApiMethodDoc(Method method, Map<Class<?>,JSONDocTemplate> jsondocTemplates)
initApiMethodDoc in class AbstractJSONDocScannerpublic ApiMethodDoc mergeApiMethodDoc(Method method, ApiMethodDoc apiMethodDoc)
mergeApiMethodDoc in class AbstractJSONDocScannerpublic ApiObjectDoc initApiObjectDoc(Class<?> clazz)
initApiObjectDoc in class AbstractJSONDocScannerpublic ApiObjectDoc mergeApiObjectDoc(Class<?> clazz, ApiObjectDoc apiObjectDoc)
mergeApiObjectDoc in class AbstractJSONDocScannerpublic Set<Class<?>> jsondocGlobal()
jsondocGlobal in class AbstractJSONDocScannerpublic Set<Class<?>> jsondocChangelogs()
jsondocChangelogs in class AbstractJSONDocScannerpublic Set<Class<?>> jsondocMigrations()
jsondocMigrations in class AbstractJSONDocScannerCopyright © 2016. All rights reserved.