目前在做前後臺分離專案的後臺介面部分，故在springboot中引入了swaggerui來做restful介面測試。本文首先描述springboot整合swaggerui的過程，其次，講述本人在整合過程中遇到的問題及解決方案。

一、springboot整合swaggerui

(1)pom檔案中新增依賴

<!-- swaggerui相關依賴 -->
		<dependency>
           <groupId>io.springfox</groupId>
           <artifactId>springfox-swagger2</artifactId>
           <version>2.7.0</version>
        </dependency>
        <dependency>
           <groupId>io.springfox</groupId>
           <artifactId>springfox-swagger-ui</artifactId>
           <version>2.7.0</version>
        </dependency>
 

（2）新增swaggerui配置類

package com.janis;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
	@Bean
	public Docket createRestApi() {
		return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
				.select()
				.apis(RequestHandlerSelectors.basePackage("com.janis.controller"))
				.paths(PathSelectors.any()).build();
	}

	private ApiInfo apiInfo() { 
		return new ApiInfoBuilder().title("janis Manage Swagger RESTful APIs")
				.description("綜合管理 Swagger API 服務")
				.termsOfServiceUrl("http://swagger.io/")
				.contact(new Contact("janis", "127.0.0.1", "
 
[email protected]"))
				.version("1.0")
				.build();

	}

}

（3）在controller中新增swaggerui介面註解

@Api(value = "檢查模板操作", description = "檢查模板操作")
@Controller
@RequestMapping("/CheckTemplate")
public class CheckTemplateController {//類上添加註解                                                                                 
 

        //方法上添加註解                                                                                                                @ApiOperation(value = "查詢檢查模板主要資訊")
	@RequestMapping(value = "/queryCheckTemplate/{pageNum},{pageSize}", method = RequestMethod.GET)
	@ResponseBody
	public CommonResponse<List<Checktemplate>> queryCheckTemplate(
			@ApiParam(name = "pageNum", value = "當前頁數") @RequestParam(value = "pageNum", required = false, defaultValue = "1") int pageNum,
			@ApiParam(name = "pageSize", value = "每頁資料量") @RequestParam(value = "pageSize", required = false, defaultValue = "1") int pageSize) {
		logger.info("查詢檢查模板主要資訊");
		// 設定分頁資訊，分別是當前頁數和每頁顯示的總記錄數,一般在service冷處理
		PageHelper.startPage(pageNum, pageSize);
		CommonResponse<List<Checktemplate>> response = new CommonResponse<>(ResponseResultEnum.SUCCESS, "查詢檢查模板主要資訊成功");
		try {
			response = checkTemplateService.queryCheckTemplate();
		} catch (Exception e) {
			response.setStatus(ResponseResultEnum.EXCEPTION);
			response.setException(ExceptionEnum.EXCEPTION_SYS);
			response.setMessage("查詢檢查模板主資訊失敗");
			logger.error("查詢檢查模板主要資訊失敗|{}", e.getMessage(), e);
			return response;
		}
		return response;
	}

常用swaggerui註解：

- @Api()用於類；
          表示標識這個類是swagger的資源
- @ApiOperation()用於方法；
            表示一個http請求的操作
- @ApiParam()用於方法，引數，欄位說明；
             表示對引數的新增元資料（說明或是否必填等）
- @ApiModel()用於類
               表示對類進行說明，用於引數用實體類接收
- @ApiModelProperty()用於方法，欄位
            表示對model屬性的說明或者資料操作更改
- @ApiIgnore()用於類，方法，方法引數
          表示這個方法或者類被忽略
- @ApiImplicitParam() 用於方法
          表示單獨的請求引數
- @ApiImplicitParams()  用於方法，包含多個 @ApiImplicitParam

二、問題及解決方案

（1）本地訪問時404

原因：springboot配置檔案中設定了資源包路徑：spring.resources.staticLocations=classpath:/res/

將此配置註釋即可。若仍舊訪問404，手動新增資源載入類：

package com.janis;

import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

//@Configuration
//@EnableWebMvc
public class WebMvcConfig extends WebMvcConfigurerAdapter {

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");

        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");

        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");

    }
}

（2）訪問成功，但是頁面無內容

原因：瀏覽器版本問題，瀏覽器不相容。更換瀏覽器或者升級瀏覽器即可。目前發現IE8不相容