Package springfox.documentation.oas.web

Class OpenApiControllerWebMvc

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

    • Constructor Summary

      Constructors 
      Constructor Description
      OpenApiControllerWebMvc​(springfox.documentation.spring.web.DocumentationCache documentationCache, ServiceModelToOpenApiMapper mapper, springfox.documentation.spring.web.json.JsonSerializer jsonSerializer, org.springframework.plugin.core.PluginRegistry<WebMvcOpenApiTransformationFilter,​springfox.documentation.spi.DocumentationType> transformations)  

    • 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 group, 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

      • OpenApiControllerWebMvc

        @Autowired
public OpenApiControllerWebMvc​(springfox.documentation.spring.web.DocumentationCache documentationCache,
                               ServiceModelToOpenApiMapper mapper,
                               springfox.documentation.spring.web.json.JsonSerializer jsonSerializer,
                               @Qualifier("webMvcOpenApiTransformationFilterRegistry")
                               org.springframework.plugin.core.PluginRegistry<WebMvcOpenApiTransformationFilter,​springfox.documentation.spi.DocumentationType> transformations)

    • Method Detail

      • getDocumentation

        @GetMapping(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 group,
                                                                                                              javax.servlet.http.HttpServletRequest servletRequest)