springboot + swagger2 生成api文檔

直接貼代碼：

<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.8.0</version>
		</dependency>
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger-ui</artifactId>
			<version>2.8.0</version>
		</dependency>

　　config

import io.swagger.annotations.ApiOperation;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
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;


//ConditionalOnProperty 注解，是為了根據配置文件的配置來指定swagger，是否生效。如果需要生效，就在application文件中配置 swagger.enable=true
@ConditionalOnProperty(prefix = "swagger",value = {"enable"},havingValue = "true")
@Configuration
@EnableSwagger2
public class SwaggerConfig extends WebMvcConfigurerAdapter {

	@Override
	public void addResourceHandlers(ResourceHandlerRegistry registry) {
		registry.addResourceHandler("swagger-ui.html")
				.addResourceLocations("classpath:/META-INF/resources/");
		registry.addResourceHandler("/webjars*")
				.addResourceLocations("classpath:/META-INF/resources/webjars/");
	}

	@Bean
	public Docket createRestApi() {
		return new Docket(DocumentationType.SWAGGER_2)
				.forCodeGeneration(true)
				.useDefaultResponseMessages(false)
				.apiInfo(apiInfo())
				.select()
//				.apis(RequestHandlerSelectors.basePackage(""))
				.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
				.paths(PathSelectors.any())
				.build();
	}

	private ApiInfo apiInfo() {
		return new ApiInfoBuilder()
				.title(" API文檔")
				.description(" API文檔")
				.version("1.0")
				.build();
	}
}

　　返回model

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

/**
 * 封裝返回數據javabean
 *
 **/
@ApiModel(value = "Result",description = "通用返回對象")
public class Result {
	public final static String MSG_SUCCESS = "success";

	@ApiModelProperty(value = "調用是否正常",name = "isok")
	private boolean isok;
	@ApiModelProperty(value = "接口返回msg，如果isok是false，那么msg是錯誤信息",name = "msg")
	private String msg;
	@ApiModelProperty(value = "調用成功，返回的數據",name = "data")
	private Object data;

	public Result() {
	}

	public Result(boolean isok, String msg) {
		this.isok = isok;
		this.msg = msg;
	}

	public Result(boolean isok, String msg, Object data) {
		this.isok = isok;
		this.msg = msg;
		this.data = data;
	}

	public boolean isIsok() {
		return isok;
	}

	public void setIsok(boolean isok) {
		this.isok = isok;
	}

	public String getMsg() {
		return msg;
	}

	public void setMsg(String msg) {
		this.msg = msg;
	}

	public Object getData() {
		return data;
	}

	public void setData(Object data) {
		this.data = data;
	}
}

　　controller  上注解：

@Api(value = "/XXX",tags = "查詢接口")

method 上注解 示例：

@ApiOperation(value = "XXX",notes = "XXXX")
	@ApiImplicitParams({
			@ApiImplicitParam(name = "methodName",value = "XXX",required = true,dataType = "String",paramType = "query"),
			@ApiImplicitParam(name = "params",value = "XXXXX",required = true,paramType = "body")
	})

public Result selectServiceRun(String methodName,
                        @RequestBody Map<String, Object> params,
                        HttpServletRequest request) {

　

說明：

• @Api：用在類上，說明該類的作用
• @ApiOperation：用在方法上，說明方法的作用
• @ApiImplicitParams：用在方法上包含一組參數說明
• @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一個請求參數的各個方面
  • paramType：參數放在哪個地方
    • header-->請求參數的獲取：@RequestHeader
    • query-->請求參數的獲取：@RequestParam
    • path（用於restful接口）-->請求參數的獲取：@PathVariable
    • body（不常用）
    • form（不常用）
  • name：參數名
  • dataType：參數類型
  • required：參數是否必須傳
  • value：參數的意思
  • defaultValue：參數的默認值
• @ApiResponses：用於表示一組響應
• @ApiResponse：用在@ApiResponses中，一般用於表達一個錯誤的響應信息
  • code：數字，例如400
  • message：信息，例如"請求參數沒填好"
  • response：拋出異常的類
• @ApiModel：描述一個Model的信息（這種一般用在post創建的時候，使用@RequestBody這樣的場景，請求參數無法使用@ApiImplicitParam注解進行描述的時候）
  • @ApiModelProperty：描述一個model的屬性