程序包 springfox.documentation.swagger2.web

类 Swagger2ControllerWebMvc

java.lang.Object

springfox.documentation.swagger2.web.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 Object

字段概要

字段

修饰符和类型	字段	说明
static String	SWAGGER2_SPECIFICATION_PATH

构造器概要

构造器

构造器	说明
Swagger2ControllerWebMvc(springfox.documentation.spring.web.DocumentationCache documentationCache, ServiceModelToSwagger2Mapper mapper, springfox.documentation.spring.web.json.JsonSerializer jsonSerializer, org.springframework.plugin.core.PluginRegistry<WebMvcSwaggerTransformationFilter,springfox.documentation.spi.DocumentationType> transformations)

方法概要

修饰符和类型	方法	说明
org.springframework.http.ResponseEntity<springfox.documentation.spring.web.json.Json>	getDocumentation(String swaggerGroup, javax.servlet.http.HttpServletRequest servletRequest)

从类继承的方法 java.lang.Object

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

字段详细资料

SWAGGER2_SPECIFICATION_PATH

public static final String SWAGGER2_SPECIFICATION_PATH

另请参阅:

常量字段值

构造器详细资料

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)

方法详细资料

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)
                                                                                                              String swaggerGroup,
                                                                                                              javax.servlet.http.HttpServletRequest servletRequest)