springfox.documentation.swagger2.web

Class Swagger2ControllerWebMvc

java.lang.Object

springfox.documentation.swagger2.web.Swagger2ControllerWebMvc

@Controller
 @ConditionalOnClass(name="javax.servlet.http.HttpServletRequest")
public class Swagger2ControllerWebMvc
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Swagger2ControllerWebMvc(org.springframework.core.env.Environment environment, springfox.documentation.spring.web.DocumentationCache documentationCache, ServiceModelToSwagger2Mapper mapper, springfox.documentation.spring.web.json.JsonSerializer jsonSerializer)

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<springfox.documentation.spring.web.json.Json>	getDocumentation(java.lang.String swaggerGroup, javax.servlet.http.HttpServletRequest servletRequest)

Methods inherited from class java.lang.Object

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

Constructor Detail

Swagger2ControllerWebMvc

@Autowired
public Swagger2ControllerWebMvc(org.springframework.core.env.Environment environment,
                                           springfox.documentation.spring.web.DocumentationCache documentationCache,
                                           ServiceModelToSwagger2Mapper mapper,
                                           springfox.documentation.spring.web.json.JsonSerializer jsonSerializer)

Method Detail

getDocumentation

@RequestMapping(value="/v2/api-docs",
                method=GET,
                produces={"application/json","application/hal+json"})
 @PropertySourcedMapping(value="${springfox.documentation.swagger.v2.path}",
                        propertyKey="springfox.documentation.swagger.v2.path")
 @ResponseBody
public org.springframework.http.ResponseEntity<springfox.documentation.spring.web.json.Json> getDocumentation(@RequestParam(value="group",required=false)
                                                                                                                                                                                                                                                                                                                                                                                                                                 java.lang.String swaggerGroup,
                                                                                                                                                                                                                                                                                                                                                                                                                                 javax.servlet.http.HttpServletRequest servletRequest)