springboot整合swagger2

1、导入依赖

<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、在项目的config目录下创建swagger配置文件

3、配置swagger

package cn.ucmed.merger.config;

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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Swagger2初始化
 *
 * @author HJH
 * @since 2017-08-08
 **/
@Configuration
@EnableSwagger2
public class Swagger2 {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("cn.ucmed.merger.api"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("就诊人接口")
                .description("描述")
                .termsOfServiceUrl("")
                .version("1.0")
                .build();
    }

}

属性说明：

basePackage：控制器层所在包

例控制器生成api文档：

package cn.ucmed.merger.api;

import cn.ucmed.merger.model.ResultBean;
import cn.ucmed.merger.model.patient.Patient;
import cn.ucmed.merger.service.PatientServiice;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.beans.factory.annotation.Autowired;
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.RestController;

import java.util.List;

@RestController
@Api(tags = "【统一就诊人接口】")
public class PatientController {

    @Autowired
    private  PatientServiice patientServiice;

    @ApiOperation(value = "根据用户id获取就诊人列表")
    @RequestMapping(value = "/getPatientList", produces = {"application/json"}, method = RequestMethod.GET)
    public ResultBean getPatientList(
        @ApiParam(value = "医院Id", required = true) @RequestParam("hospitalId") String hospitalId,
        @ApiParam(value = "用户Id", required = true) @RequestParam("userId") String userId,
        @ApiParam(value = "医联体Id", required = true) @RequestParam("unionId") String unionId
    ) {
        List<Patient> patients = patientServiice.getPatientList(hospitalId, userId, unionId);
        return ResultBean.success(patients);
    }
}