org.jsondoc.springmvc.scanner

Class SpringJSONDocScanner

java.lang.Object

org.jsondoc.core.util.AbstractJSONDocScanner

org.jsondoc.springmvc.scanner.SpringJSONDocScanner

All Implemented Interfaces:

JSONDocScanner

public class SpringJSONDocScanner
extends AbstractJSONDocScanner

Field Summary

Fields inherited from class org.jsondoc.core.util.AbstractJSONDocScanner

allApiMethodDocs, log, reflections

Constructor Summary

Constructors

Constructor and Description
SpringJSONDocScanner()

Method Summary

Methods

Modifier and Type	Method and Description
ApiDoc	mergeApiDoc(Class<?> controller, ApiDoc apiDoc)
ApiMethodDoc	mergeApiMethodDoc(Method method, Class<?> controller, ApiMethodDoc apiMethodDoc) This method merges the documentation built with the JSONDoc default scanner with data extracted from the Spring's annotations.
ApiParamDoc	mergeApiPathParamDoc(Method method, int paramIndex, ApiParamDoc apiParamDoc)
ApiParamDoc	mergeApiQueryParamDoc(Method method, int paramIndex, ApiParamDoc apiParamDoc)

Methods inherited from class org.jsondoc.core.util.AbstractJSONDocScanner

enumConstantsToStringArray, getApiAuthDocForController, getApiAuthDocForMethod, getApiDocs, getApiDocsMap, getApiFlowDocs, getApiFlowDocsMap, getApiObjectDocs, getApiObjectsMap, getApiPathParamDocs, getApiQueryParamDocs, getJSONDoc

Methods inherited from class java.lang.Object

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

Constructor Detail

SpringJSONDocScanner

public SpringJSONDocScanner()

Method Detail

mergeApiDoc

public ApiDoc mergeApiDoc(Class<?> controller,
                 ApiDoc apiDoc)

Specified by:

mergeApiDoc in class AbstractJSONDocScanner

mergeApiMethodDoc

public ApiMethodDoc mergeApiMethodDoc(Method method,
                             Class<?> controller,
                             ApiMethodDoc apiMethodDoc)

This method merges the documentation built with the JSONDoc default scanner with data extracted from the Spring's annotations. Path is calculated as the concatenation between the RequestMapping "value" on the controller class and the RequestMapping "value" on the method signature. Eventually replaces the "path" value of the JSONDoc annotation. Verb follows the same approach as "path". Produces (consumes) are calculated by looking at the RequestMapping "produces" ("consumes") and in case they are redefined at method level, then those overwrite the previous ones. Headers follow the same approach as "produces" and "consumes". Response objects are calculated by the JSONDoc default scanner and then eventually modified in case the return object is a ResponseEntity class, in that case the "responseentity" string is removed from the final documentation because not meaningful for documentation users. Request body is calculated by the JSONDoc default scanner. No need for integration with Spring's RequestBody annotation.

Specified by:

mergeApiMethodDoc in class AbstractJSONDocScanner

mergeApiPathParamDoc

public ApiParamDoc mergeApiPathParamDoc(Method method,
                               int paramIndex,
                               ApiParamDoc apiParamDoc)

Specified by:

mergeApiPathParamDoc in class AbstractJSONDocScanner

mergeApiQueryParamDoc

public ApiParamDoc mergeApiQueryParamDoc(Method method,
                                int paramIndex,
                                ApiParamDoc apiParamDoc)

Specified by:

mergeApiQueryParamDoc in class AbstractJSONDocScanner