springboot-swagger報錯

一类缤、具體步驟：

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

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>

    <!-- swagger-ui為項目提供api展示及測試的界面 -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.7.0</version>
    </dependency>

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 <a href="934804229">934804229</a>
@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

<mvc:resources mapping="swagger-ui.html" location="classpath:/META-INF/resources/" />
<mvc:resources mapping="/webjars/" location="classpath:/META-INF/resources/webjars/" />
<bean class="cn....common.SwaggerConfig"/>
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<HashMap> 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以上再試試！

<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.30</version>
</dependency>
三莹规、swagger2注解含義

以下是swagger2注解中的全參數(shù)赔蒲，有興趣可以都試試

@Api
Api 標記可以標記一個Controller類做為swagger 文檔資源，使用方式

屬性名稱

備注

value

url的路徑值

springboot-swagger報錯

推薦閱讀更多精彩內(nèi)容