springfox.documentation.swagger1.web

Class Swagger1Controller

java.lang.Object

springfox.documentation.swagger1.web.Swagger1Controller

@Controller
public class Swagger1Controller
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Swagger1Controller(DocumentationCache documentationCache, ServiceModelToSwaggerMapper mapper, JsonSerializer jsonSerializer)

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<Json>	getApiListing(java.lang.String swaggerGroup, java.lang.String apiDeclaration, javax.servlet.http.HttpServletRequest servletRequest)
org.springframework.http.ResponseEntity<Json>	getResourceListing(java.lang.String swaggerGroup)

Methods inherited from class java.lang.Object

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

Constructor Detail

Swagger1Controller

@Autowired
public Swagger1Controller(DocumentationCache documentationCache,
                                     ServiceModelToSwaggerMapper mapper,
                                     JsonSerializer jsonSerializer)

Method Detail

getResourceListing

@RequestMapping(value="/api-docs",
                method=GET)
 @PropertySourcedMapping(value="${springfox.documentation.swagger.v1.path}",
                        propertyKey="springfox.documentation.swagger.v1.path")
 @ResponseBody
public org.springframework.http.ResponseEntity<Json> getResourceListing(@RequestParam(value="group",required=false)
                                                                                                                                                                                                                                                                                                                  java.lang.String swaggerGroup)

getApiListing

@RequestMapping(value="/api-docs/{swaggerGroup}/{apiDeclaration}",
                method=GET)
 @PropertySourcedMapping(value="${springfox.documentation.swagger.v1.path}/{swaggerGroup}/{apiDeclaration}",
                        propertyKey="springfox.documentation.swagger.v1.path")
 @ResponseBody
public org.springframework.http.ResponseEntity<Json> getApiListing(@PathVariable
                                                                                                                                                                                                                                                                                                                                                                             java.lang.String swaggerGroup,
                                                                                                                                                                                                                                                                                                                                                                             @PathVariable
                                                                                                                                                                                                                                                                                                                                                                             java.lang.String apiDeclaration,
                                                                                                                                                                                                                                                                                                                                                                             javax.servlet.http.HttpServletRequest servletRequest)