springboot-swagger报错

一、具体步骤：

1.1、pom.xml，引入springfox-swagger2和springfox-swagger-ui架包：

io.springfox
springfox-swagger2
2.7.0

    
    
        io.springfox
        springfox-swagger-ui
        2.7.0

1.2、配置SwaggerConfig.java

import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**

@author 934804229
@version 2019/8/19 17:23
@description SwaggerConfig2
*/
@Configuration
@EnableWebMvc
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
//.apis(RequestHandlerSelectors.any()) //显示所有类
//.apis(RequestHandlerSelectors.withClassAnnotation(Api.class)) //只显示添加@Api注解的类
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))//只显示添加@ApiOperation注解的接口
.build()
.apiInfo(apiInfo());
}

private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("开放接口API") //粗标题
.description("HTTP对外开放接口") //描述
.version("1.0.0") //api version
.termsOfServiceUrl("http://IP:PORT/OBJ-NAME/swagger-ui.html")
// .license("LICENSE") //链接名称
// .licenseUrl("http://xxx.xxx.com") //链接地址
.build();
}
}
1.3、配置spring-servlet.xml

1.4、接口类注解配置配置

@Controller
@RequestMapping(value = "/api")
@Api(value = "emsModel", description = "快递查询模块", produces = MediaType.APPLICATION_JSON_VALUE)
public class EmsController {

@ResponseBody
@RequestMapping(value = "/v2/emsModel/emsQuery")
@ApiOperation(value = "EMS查询接口v2版", httpMethod = "POST", response = ResponseMainEntity.class, notes = "EMS查询接口v2版")
public ResponseMainEntity emsQuery(@RequestBody RequestMainEntity requestData) {
    ResponseMainEntity responseMainEntity = new ResponseMainEntity();
    responseMainEntity = emsQueryV1(requestData);
    return responseMainEntity;
}

}
注：如果是实体接受，需要采用@RequestBody注解去注释实体。

1.5、Swagger访问路径：

http://IP:PORT/项目名称/swagger-ui.html

效果图如下：

1.6、swagger注解含义见下面第三项

二、报错解决方案

2.1、如果报：swagger-ui.min.js:8 Uncaught TypeError: Cannot read property 'definitions' of null

解决方案：检查是否引入fastjson架包，如果是，检查其版本是不是1.2以下的版本，swagger2好像对1.2以下的fastjson版本不支持，升级至1.2以上再试试！

com.alibaba
fastjson
1.2.30

三、swagger2注解含义

以下是swagger2注解中的全参数，有兴趣可以都试试

@Api
Api 标记可以标记一个Controller类做为swagger 文档资源，使用方式

属性名称

备注

value

url的路径值

springboot-swagger报错

你可能感兴趣的:(springboot-swagger报错)