swagger是一款高效易用的嵌入式文件外掛,同時支援線上測試介面，快速生成客戶端程式碼。spring-boot-starter-swagger通過spring-boot方式配置的swagger實現。完美並且完整的支援swagger-spring的所有配置項，配置及其簡單，容易上手。支援api分組配置，通過正則表示式方式分組。支援分環境配置，你可以很容易讓你的專案api文件在開發環境，測試環境。

依賴包

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

model中常用的註解：@ApiModel 註解類名，@ApiModelProperty 註解方法或者引數名

UserModel

package com.swagger.model;

import java.io.Serializable;

import io.swagger.annotations.ApiModelProperty;

/**
 * <p>
 * 角色
 * </p>
 * 
 * @author lixin([email protected])
 * @since 2018-08-03
 */
public class UserModel implements Serializable {

	private static final long serialVersionUID = 1L;
	
	@ApiModelProperty(value = "id", required = false, position = 1, example = "10001")
	private Long userId;
	
	@ApiModelProperty(value = "編號", required = false, position = 1, example = "10001")
	private String userCode;
	
	@ApiModelProperty(value = "名稱", required = false, position = 1, example = "張三")
	private String userName;
	
	public UserModel() {
		
	}
	
	public UserModel(long userId, String userCode,String userName) {
		this.setUserId(userId);
		this.setUserCode(userCode);
		this.setUserName(userName);
	}

	public Long getUserId() {
		return userId;
	}

	public void setUserId(Long userId) {
		this.userId = userId;
	}

	public String getUserCode() {
		return userCode;
	}

	public void setUserCode(String userCode) {
		this.userCode = userCode;
	}

	public String getUserName() {
		return userName;
	}

	public void setUserName(String userName) {
		this.userName = userName;
	}

	@Override
	public String toString() {
		return "UserModel [userId=" + userId + ", userCode=" + userCode + ", userName=" + userName + "]";
	}

}
 

控制器中常用的註解： @Api 註解控制器顯示的標識，有tags和description可以配置控制器顯示的標識;@ApiOperation 用來註解控制器方法顯示的標識； @ApiParam 用來註解控制器方法引數的名字，控制器方法在文件中需要顯示的預設值

UserController

package com.swagger.web.controller;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;

import com.swagger.api.IUserService;
import com.swagger.model.UserModel;
import com.swagger.util.ApiConst;
import com.swagger.util.ResultEntity;

import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;

/**
 * <p>
 * 角色前端控制器
 * </p>
 *
 * @author lixin(
 
[email protected])
 * @since 2018-08-03
 */
@Controller
@RequestMapping("/user")
public class UserController {

	private @Autowired IUserService userService;

	@ApiOperation(value = "新增")
	@RequestMapping(value = "/addUser", method = RequestMethod.POST, produces = {
			MediaType.APPLICATION_JSON_UTF8_VALUE })
	public @ResponseBody ResultEntity<String> addUser(
			@ApiParam(value = "id", required = true) @RequestParam(value = "userId", required = true) Long userId,
			@ApiParam(value = "角色編號", required = true) @RequestParam(value = "userCode", required = true) String userCode,
			@ApiParam(value = "角色名稱", required = true) @RequestParam(value = "userName", required = true) String userName) {
		try {
			UserModel user = new UserModel();
			user.setUserId(userId);
			user.setUserCode(userCode);
			user.setUserName(userName);
			userService.addUser(user);
			return new ResultEntity<String>(ApiConst.CODE_SUCC, ApiConst.DESC_SUCC);
		} catch (Exception e) {
			e.getStackTrace();
		}
		return new ResultEntity<String>(ApiConst.CODE_FAIL, ApiConst.DESC_FAIL);
	}
	@ApiOperation(value = "查詢")
	@RequestMapping(value = "/getUser", method = RequestMethod.POST, produces = {
			MediaType.APPLICATION_JSON_UTF8_VALUE })
	public @ResponseBody ResultEntity<List<UserModel>> getUser() {
		try {
			List<UserModel> list = userService.getUser();
			return new ResultEntity<List<UserModel>>(ApiConst.CODE_SUCC, ApiConst.DESC_SUCC,list);
		} catch (Exception e) {
			e.getStackTrace();
		}
		return new ResultEntity<List<UserModel>>(ApiConst.CODE_FAIL, ApiConst.DESC_FAIL);
	}
	
}

swaggerConfig配置

@Configuration
@EnableSwagger2
public class SwaggerConfig {

	@Bean
	public Docket customDocket() {
		return new Docket(DocumentationType.SWAGGER_2)
				.apiInfo(apiInfo())
				.select()
				.apis(RequestHandlerSelectors.basePackage("com.swagger.web.controller"))
				.paths(PathSelectors.any())
				.build();
	}

	private ApiInfo apiInfo() {
		 return new ApiInfoBuilder()
//	                .title("")
	                .description("測試介面Api")
	                .termsOfServiceUrl("127.0.0.1")
	                .version("1.0")
	                .build();
	}

然後我們在看看我們自己的Ui，雖然和v2版的差不多，但是裡面有些不同

這是我們Ui的靜態資源

實際應用中，我們會有在專案服務啟動的時候就去載入一些資料或做一些事情這樣的需求。 
為了解決這樣的問題，Spring Boot 為我們提供了一個方法，通過實現介面 CommandLineRunner 來實現。

SwaggerCommandLineRunner

package com.swagger.config;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.CommandLineRunner;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

/** 
* @ClassName: SwaggerCommandLineRunner 
* @Description: TODO(啟動載入swagger) 
* @author lixin
* @date 2018年8月17日 下午4:17:32 
*  
*/
@Component
@Order(value = 1)
public class SwaggerCommandLineRunner implements CommandLineRunner {

	private static Logger logger = LoggerFactory.getLogger(SwaggerCommandLineRunner.class);

	@Override
	public void run(String... args) throws Exception {
		logger.debug(">>>>>>>>>>>>>>服務啟動載入:swagger初始化<<<<<<<<<<<<<");
	}

}

OK，下面來說一說SpringBoot 的攔截器配置，這裡的攔截器配置分為  SpringBoot 1.X版本和 SpringBoot 2.X版本：

SpringBoot 1.X用的是 繼承 WebMvcConfigurerAdapter類；

在SpringBoot 2.X中，WebMvcConfigurerAdapter這個類已經過時了，可以用繼承WebMvcConfigurationSupport，也可以實現 WebMvcConfigurer這個介面；在使用這個SpringBoot 2.X配置攔截器後，發現靜態資源居然也被攔截了，這裡就需要我們在過濾條件時，放開靜態資源路徑，我使用的是實現 WebMvcConfigurer這個介面。下面是攔截器的配置：

WebInterceptor

package com.swagger.config;

import java.io.PrintWriter;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import net.sf.json.JSONObject;

/**  
* @ClassName: WebInterceptor  
* @Description: TODO()  
* @author lixin([email protected])  
* @date 2018年8月18日 下午2:58:42  
* @version V1.0  
*/ 
public class WebInterceptor implements HandlerInterceptor {
	
	 @Override
	    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
		 System.out.println("==============  request before  ==============");
	        httpServletResponse.addHeader("Access-Control-Allow-Origin", "*");
	        httpServletResponse.addHeader("Access-Control-Allow-Methods", "*");
	        httpServletResponse.addHeader("Access-Control-Max-Age", "1800");
	        httpServletResponse.addHeader("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept, token");
	        httpServletResponse.addHeader("Access-Control-Allow-Credentials", "true");
	        httpServletResponse.setContentType("application/json;charset=UTF-8");
	        httpServletResponse.setHeader("Cache-Control", "no-cache");
	        String token = httpServletRequest.getHeader("token");
			if(null != token){
				return true;
			}
			PrintWriter out = httpServletResponse.getWriter();
			JSONObject res = new JSONObject();
		    res.put("success","false");
		    res.put("msg","登入資訊失效，請重新登入！");
		    out.append(res.toString());
			out.flush();  
			return false;
	    }

	    @Override
	    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
	        System.out.println("==============  request  ==============");
	    }

	    @Override
	    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
	        System.out.println("==============  request completion  ==============");
	    }
}

WebMvcConfig

package com.swagger.config;

import java.util.Arrays;

import javax.servlet.MultipartConfigElement;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.web.servlet.MultipartConfigFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**  
* @ClassName: WebMvcConfig  
* @Description: TODO()  
* @author lixin([email protected])  
* @date 2018年8月18日 下午2:58:52  
* @version V1.0  
*/ 
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
	
	private static Logger logger = LoggerFactory.getLogger(SwaggerCommandLineRunner.class);

	/* (非 Javadoc)
	* <p>Title: addCorsMappings</p>
	* <p>Description: 跨域</p>
	* @param registry
	* @see org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter#addCorsMappings(org.springframework.web.servlet.config.annotation.CorsRegistry)
	*/
	@Override
	public void addCorsMappings(CorsRegistry registry) {
		registry.addMapping("/**")
			.allowedOrigins("*")
			.allowCredentials(true)
			.allowedMethods("GET", "POST", "DELETE", "PUT")
			.maxAge(3600);
	}
	
	 public void addInterceptors(InterceptorRegistry registry) {
//		 	registry.addInterceptor(new WebInterceptor());
	        registry.addInterceptor(new WebInterceptor()).excludePathPatterns(Arrays.asList("/static/**","/api/**")); //放開靜態資源攔截
	        logger.debug(">>>>>>>>>>>>>> 攔截器註冊完畢<<<<<<<<<<<<<");
	    }
	 /** 上傳附件容量限制 */
		@Bean
		public MultipartConfigElement multipartConfigElement() {
			MultipartConfigFactory factory = new MultipartConfigFactory();
			factory.setMaxFileSize("102400KB");
			factory.setMaxRequestSize("112400KB");
			return factory.createMultipartConfig();
		}
}

OK到這裡，我們的配置也就結束了。

不填token

填入token