springfox.documentation.swagger2.web

Class Swagger2Controller

java.lang.Object

springfox.documentation.swagger2.web.Swagger2Controller

@Controller
public class Swagger2Controller
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_URL

Constructor Summary

Constructors

Constructor and Description
Swagger2Controller(org.springframework.core.env.Environment environment, DocumentationCache documentationCache, ServiceModelToSwagger2Mapper mapper, JsonSerializer jsonSerializer)

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<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

Field Detail

DEFAULT_URL

public static final java.lang.String DEFAULT_URL

See Also:

Constant Field Values

Constructor Detail

Swagger2Controller

@Autowired
public Swagger2Controller(org.springframework.core.env.Environment environment,
                            DocumentationCache documentationCache,
                            ServiceModelToSwagger2Mapper mapper,
                            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<Json> getDocumentation(@RequestParam(value="group",required=false)
                                                                                                                                java.lang.String swaggerGroup,
                                                                                                                                javax.servlet.http.HttpServletRequest servletRequest)