com.knappsack.swagger4springweb.controller

Class ApiDocumentationController

java.lang.Object

com.knappsack.swagger4springweb.controller.ApiDocumentationController

@Controller
 @RequestMapping(value="/api")
public class ApiDocumentationController
extends Object

Constructor Summary

Constructors

Constructor and Description
ApiDocumentationController()

Method Summary

Modifier and Type	Method and Description
List<String>	getAdditionalControllerPackages()
List<String>	getAdditionalModelPackages()
com.wordnik.swagger.model.ApiInfo	getApiInfo()
String	getBaseControllerPackage()
String	getBaseModelPackage()
String	getBasePath()
Map<String,com.wordnik.swagger.model.ApiListing>	getDocumentation()
com.wordnik.swagger.model.ApiListing	getDocumentation(javax.servlet.http.HttpServletRequest request)
List<String>	getIgnorableAnnotations()
com.wordnik.swagger.model.ResourceListing	getResources(javax.servlet.http.HttpServletRequest request)
boolean	isIgnoreUnusedPathVariables()
void	setAdditionalControllerPackages(List<String> additionalControllerPackages)
void	setAdditionalModelPackages(List<String> additionalModelPackages)
void	setApiInfo(com.wordnik.swagger.model.ApiInfo apiInfo)
void	setApiVersion(String apiVersion)
void	setBaseControllerPackage(String baseControllerPackage)
void	setBaseModelPackage(String baseModelPackage)
void	setBasePath(String basePath)
void	setBasePathFromReferer(boolean basePathFromReferer)
void	setDocumentation(Map<String,com.wordnik.swagger.model.ApiListing> documentation)
void	setFilters(List<Filter> filters)
void	setIgnorableAnnotations(List<String> ignorableAnnotations)
void	setIgnoreUnusedPathVariables(boolean ignoreUnusedPathVariables)
void	setResourceList(com.wordnik.swagger.model.ResourceListing resourceList)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiDocumentationController

public ApiDocumentationController()

Method Detail

getResources

@RequestMapping(value="/resourceList",
                method=GET,
                produces="application/json")
 @ResponseBody
public com.wordnik.swagger.model.ResourceListing getResources(javax.servlet.http.HttpServletRequest request)

getDocumentation

@RequestMapping(value="/resourceList/doc/**",
                method=GET,
                produces="application/json")
 @ResponseBody
public com.wordnik.swagger.model.ApiListing getDocumentation(javax.servlet.http.HttpServletRequest request)

getBasePath

public String getBasePath()

setResourceList

public void setResourceList(com.wordnik.swagger.model.ResourceListing resourceList)

getBaseControllerPackage

public String getBaseControllerPackage()

setBaseControllerPackage

public void setBaseControllerPackage(String baseControllerPackage)

getAdditionalControllerPackages

public List<String> getAdditionalControllerPackages()

setAdditionalControllerPackages

public void setAdditionalControllerPackages(List<String> additionalControllerPackages)

getBaseModelPackage

public String getBaseModelPackage()

setBaseModelPackage

public void setBaseModelPackage(String baseModelPackage)

getAdditionalModelPackages

public List<String> getAdditionalModelPackages()

setAdditionalModelPackages

public void setAdditionalModelPackages(List<String> additionalModelPackages)

getDocumentation

public Map<String,com.wordnik.swagger.model.ApiListing> getDocumentation()

setDocumentation

public void setDocumentation(Map<String,com.wordnik.swagger.model.ApiListing> documentation)

getIgnorableAnnotations

public List<String> getIgnorableAnnotations()

setIgnorableAnnotations

public void setIgnorableAnnotations(List<String> ignorableAnnotations)

isIgnoreUnusedPathVariables

public boolean isIgnoreUnusedPathVariables()

setIgnoreUnusedPathVariables

public void setIgnoreUnusedPathVariables(boolean ignoreUnusedPathVariables)

setBasePathFromReferer

public void setBasePathFromReferer(boolean basePathFromReferer)

getApiInfo

public com.wordnik.swagger.model.ApiInfo getApiInfo()

setApiInfo

public void setApiInfo(com.wordnik.swagger.model.ApiInfo apiInfo)

setFilters

public void setFilters(List<Filter> filters)

setBasePath

public void setBasePath(String basePath)

setApiVersion

public void setApiVersion(String apiVersion)