Package springfox.documentation.swagger2.web

Class Swagger2ControllerWebMvc

  • @RestController
@ConditionalOnWebApplication(type=SERVLET)
@RequestMapping("${springfox.documentation.swagger.v2.path:/v2/api-docs}")
@Conditional(springfox.documentation.spring.web.OnServletBasedWebApplication.class)
@Order(-2147483648)
public class Swagger2ControllerWebMvc
extends java.lang.Object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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

    • Field Detail

      • SWAGGER2_SPECIFICATION_PATH

        public static final java.lang.String SWAGGER2_SPECIFICATION_PATH
        See Also:
        Constant Field Values

    • Constructor Detail

      • Swagger2ControllerWebMvc

        @Autowired
public Swagger2ControllerWebMvc​(springfox.documentation.spring.web.DocumentationCache documentationCache,
                                ServiceModelToSwagger2Mapper mapper,
                                springfox.documentation.spring.web.json.JsonSerializer jsonSerializer,
                                @Qualifier("webMvcSwaggerTransformationFilterRegistry")
                                org.springframework.plugin.core.PluginRegistry<WebMvcSwaggerTransformationFilter,​springfox.documentation.spi.DocumentationType> transformations)

    • Method Detail

      • getDocumentation

        @RequestMapping(method=GET,
                produces={"application/json","application/hal+json"})
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)