com.apporiented.rest.apidoc.factory.impl

Class SpringControllerDocumentationFactory

java.lang.Object

com.apporiented.rest.apidoc.factory.impl.SpringControllerDocumentationFactory

All Implemented Interfaces:

ControllerDocumentationFactory

public class SpringControllerDocumentationFactory
extends Object
implements ControllerDocumentationFactory

Implementation of a factory that creates documentation for REST resources (controllers) based on internal annotations and Spring MVC annotations.

Author:

Lars Behnke

Constructor Summary

Constructors

Constructor and Description
SpringControllerDocumentationFactory(ModelDocumentationFactory modelDocumentationFactory)

Method Summary

Modifier and Type	Method and Description
ApiDocModel	createApiDocModel(Class<?> ctrlClass)
List<ApiParamDocModel>	createApiParamDocs(Method method)

Methods inherited from class java.lang.Object

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

Constructor Detail

SpringControllerDocumentationFactory

public SpringControllerDocumentationFactory(ModelDocumentationFactory modelDocumentationFactory)

Method Detail

createApiDocModel

public ApiDocModel createApiDocModel(Class<?> ctrlClass)

Specified by:

createApiDocModel in interface ControllerDocumentationFactory

createApiParamDocs

public List<ApiParamDocModel> createApiParamDocs(Method method)