Package springfox.documentation.oas.web

Class OpenApiControllerWebMvc

java.lang.Object

springfox.documentation.oas.web.OpenApiControllerWebMvc

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

Constructor Summary

Constructors

Constructor	Description
OpenApiControllerWebMvc(DocumentationCache documentationCache, ServiceModelToOpenApiMapper mapper, JsonSerializer jsonSerializer, org.springframework.plugin.core.PluginRegistry<WebMvcOpenApiTransformationFilter,DocumentationType> transformations)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<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(DocumentationCache documentationCache,
                               ServiceModelToOpenApiMapper mapper,
                               JsonSerializer jsonSerializer,
                               @Qualifier("webMvcOpenApiTransformationFilterRegistry")
                               org.springframework.plugin.core.PluginRegistry<WebMvcOpenApiTransformationFilter,DocumentationType> transformations)

Method Detail

getDocumentation

@GetMapping(produces={"application/json","application/hal+json"})
public org.springframework.http.ResponseEntity<Json> getDocumentation(@RequestParam(value="group",required=false)
                                                                      java.lang.String group,
                                                                      javax.servlet.http.HttpServletRequest servletRequest)