Index

A B G I J M O S
All Classes|All Packages

A

AbstractSpringJSONDocScanner - Class in org.jsondoc.springmvc.scanner

AbstractSpringJSONDocScanner() - Constructor for class org.jsondoc.springmvc.scanner.AbstractSpringJSONDocScanner

B

buildConsumes(Method) - Static method in class org.jsondoc.springmvc.scanner.builder.SpringConsumesBuilder

From Spring's documentation: [consumes is] supported at the type level as well as at the method level! When used at the type level, all method-level mappings override this consumes restriction.

buildHeaders(Method) - Static method in class org.jsondoc.springmvc.scanner.builder.SpringHeaderBuilder

From Spring's documentation: Supported at the type level as well as at the method level! When used at the type level, all method-level mappings inherit this header restriction.

buildJSONDocObjectsCandidates(Set<Class<?>>, Class<?>, Type, Reflections) - Static method in class org.jsondoc.springmvc.scanner.AbstractSpringJSONDocScanner

Returns a set of classes that are either return types or body objects

buildObject(Class<?>) - Static method in class org.jsondoc.springmvc.scanner.builder.SpringObjectBuilder

buildPath(Method) - Static method in class org.jsondoc.springmvc.scanner.builder.SpringPathBuilder

From Spring's documentation: Supported at the type level as well as at the method level! When used at the type level, all method-level mappings inherit this primary mapping, narrowing it for a specific handler method.

buildPathVariable(Method) - Static method in class org.jsondoc.springmvc.scanner.builder.SpringPathVariableBuilder

buildProduces(Method) - Static method in class org.jsondoc.springmvc.scanner.builder.SpringProducesBuilder

From Spring's documentation: [produces is] supported at the type level as well as at the method level! When used at the type level, all method-level mappings override this produces restriction.

buildQueryParams(Method) - Static method in class org.jsondoc.springmvc.scanner.builder.SpringQueryParamBuilder

From Spring's documentation: Supported at the type level as well as at the method level! When used at the type level, all method-level mappings inherit this parameter restriction

buildRequestBody(Method) - Static method in class org.jsondoc.springmvc.scanner.builder.SpringRequestBodyBuilder

buildResponse(Method) - Static method in class org.jsondoc.springmvc.scanner.builder.SpringResponseBuilder

Builds the ApiResponseObjectDoc from the method's return type and checks if the first type corresponds to a ResponseEntity class.

buildResponseStatusCode(Method) - Static method in class org.jsondoc.springmvc.scanner.builder.SpringResponseStatusBuilder

buildVerb(Method) - Static method in class org.jsondoc.springmvc.scanner.builder.SpringVerbBuilder

From Spring's documentation: When [RequestMapping method is] used at the type level, all method-level mappings inherit this HTTP method restriction

G

getAnnotation(Class<?>, Class<T>) - Static method in class org.jsondoc.springmvc.scanner.SpringBuilderUtils

getAnnotation(Method, Class<T>) - Static method in class org.jsondoc.springmvc.scanner.SpringBuilderUtils

getApi() - Method in class org.jsondoc.springmvc.controller.JSONDocController

getDisplayMethodAs() - Method in class org.jsondoc.springmvc.controller.JSONDocController

I

initApiDoc(Class<?>) - Method in class org.jsondoc.springmvc.scanner.AbstractSpringJSONDocScanner

ApiDoc is initialized with the Controller's simple class name.

initApiMethodDoc(Method, Map<Class<?>, JSONDocTemplate>) - Method in class org.jsondoc.springmvc.scanner.AbstractSpringJSONDocScanner

initApiObjectDoc(Class<?>) - Method in class org.jsondoc.springmvc.scanner.AbstractSpringJSONDocScanner

isAnnotated(Class<?>, Class<? extends Annotation>) - Static method in class org.jsondoc.springmvc.scanner.SpringBuilderUtils

isAnnotated(Method, Class<? extends Annotation>) - Static method in class org.jsondoc.springmvc.scanner.SpringBuilderUtils

isPlaygroundEnabled() - Method in class org.jsondoc.springmvc.controller.JSONDocController

J

JSONDOC_DEFAULT_PATH - Static variable in class org.jsondoc.springmvc.controller.JSONDocController

jsondocChangelogs() - Method in class org.jsondoc.springmvc.scanner.AbstractSpringJSONDocScanner

JSONDocController - Class in org.jsondoc.springmvc.controller

JSONDocController(String, String, List<String>) - Constructor for class org.jsondoc.springmvc.controller.JSONDocController

jsondocControllers() - Method in class org.jsondoc.springmvc.scanner.Spring3JSONDocScanner

jsondocControllers() - Method in class org.jsondoc.springmvc.scanner.Spring4JSONDocScanner

jsondocFlows() - Method in class org.jsondoc.springmvc.scanner.AbstractSpringJSONDocScanner

jsondocGlobal() - Method in class org.jsondoc.springmvc.scanner.AbstractSpringJSONDocScanner

jsondocMethods(Class<?>) - Method in class org.jsondoc.springmvc.scanner.AbstractSpringJSONDocScanner

jsondocMigrations() - Method in class org.jsondoc.springmvc.scanner.AbstractSpringJSONDocScanner

jsondocObjects(List<String>) - Method in class org.jsondoc.springmvc.scanner.AbstractSpringJSONDocScanner

M

mergeApiDoc(Class<?>, ApiDoc) - Method in class org.jsondoc.springmvc.scanner.AbstractSpringJSONDocScanner

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.

mergeApiMethodDoc(Method, ApiMethodDoc) - Method in class org.jsondoc.springmvc.scanner.AbstractSpringJSONDocScanner

mergeApiObjectDoc(Class<?>, ApiObjectDoc) - Method in class org.jsondoc.springmvc.scanner.AbstractSpringJSONDocScanner

O

org.jsondoc.springmvc.controller - package org.jsondoc.springmvc.controller

org.jsondoc.springmvc.scanner - package org.jsondoc.springmvc.scanner

org.jsondoc.springmvc.scanner.builder - package org.jsondoc.springmvc.scanner.builder

S

setDisplayMethodAs(JSONDoc.MethodDisplay) - Method in class org.jsondoc.springmvc.controller.JSONDocController

setPlaygroundEnabled(boolean) - Method in class org.jsondoc.springmvc.controller.JSONDocController

Spring3JSONDocScanner - Class in org.jsondoc.springmvc.scanner

Spring3JSONDocScanner() - Constructor for class org.jsondoc.springmvc.scanner.Spring3JSONDocScanner

Spring4JSONDocScanner - Class in org.jsondoc.springmvc.scanner

Spring4JSONDocScanner() - Constructor for class org.jsondoc.springmvc.scanner.Spring4JSONDocScanner

SpringBuilderUtils - Class in org.jsondoc.springmvc.scanner

SpringBuilderUtils() - Constructor for class org.jsondoc.springmvc.scanner.SpringBuilderUtils

SpringConsumesBuilder - Class in org.jsondoc.springmvc.scanner.builder

SpringConsumesBuilder() - Constructor for class org.jsondoc.springmvc.scanner.builder.SpringConsumesBuilder

SpringHeaderBuilder - Class in org.jsondoc.springmvc.scanner.builder

SpringHeaderBuilder() - Constructor for class org.jsondoc.springmvc.scanner.builder.SpringHeaderBuilder

SpringObjectBuilder - Class in org.jsondoc.springmvc.scanner.builder

SpringObjectBuilder() - Constructor for class org.jsondoc.springmvc.scanner.builder.SpringObjectBuilder

SpringPathBuilder - Class in org.jsondoc.springmvc.scanner.builder

SpringPathBuilder() - Constructor for class org.jsondoc.springmvc.scanner.builder.SpringPathBuilder

SpringPathVariableBuilder - Class in org.jsondoc.springmvc.scanner.builder

SpringPathVariableBuilder() - Constructor for class org.jsondoc.springmvc.scanner.builder.SpringPathVariableBuilder

SpringProducesBuilder - Class in org.jsondoc.springmvc.scanner.builder

SpringProducesBuilder() - Constructor for class org.jsondoc.springmvc.scanner.builder.SpringProducesBuilder

SpringQueryParamBuilder - Class in org.jsondoc.springmvc.scanner.builder

SpringQueryParamBuilder() - Constructor for class org.jsondoc.springmvc.scanner.builder.SpringQueryParamBuilder

SpringRequestBodyBuilder - Class in org.jsondoc.springmvc.scanner.builder

SpringRequestBodyBuilder() - Constructor for class org.jsondoc.springmvc.scanner.builder.SpringRequestBodyBuilder

SpringResponseBuilder - Class in org.jsondoc.springmvc.scanner.builder

SpringResponseBuilder() - Constructor for class org.jsondoc.springmvc.scanner.builder.SpringResponseBuilder

SpringResponseStatusBuilder - Class in org.jsondoc.springmvc.scanner.builder

SpringResponseStatusBuilder() - Constructor for class org.jsondoc.springmvc.scanner.builder.SpringResponseStatusBuilder

SpringVerbBuilder - Class in org.jsondoc.springmvc.scanner.builder

SpringVerbBuilder() - Constructor for class org.jsondoc.springmvc.scanner.builder.SpringVerbBuilder

A B G I J M O S
All Classes|All Packages