Spring Boot使用Swagger2

使用Swagger可以很方便地制作项目后台得API文档。下面我记录一下最近在项目中是如何使用Swagger2的。
1.首先在maven配置文件pom.xml中添加Swagger2的依赖

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

2.在springboot的Application类的同级创建Swagger2的配置类

//通过@Configuration注解，让Spring来加载该类配置。//再通过@EnableSwagger2注解来启用Swagger2@Configuration@EnableSwagger2public class Swagger2 {    @Bean    public Docket createRestApi() {        return new Docket(DocumentationType.SWAGGER_2)                .apiInfo(apiInfo())                .select()                .apis(RequestHandlerSelectors.basePackage("cn.gzcc.fe.web"))                .paths(PathSelectors.any())                .build();    }    private ApiInfo apiInfo() {        return new ApiInfoBuilder()                .title("****系统--API接口文档")                .description("大头死变态")                .contact("XT")                .version("1.0")                .build();    }}

3.添加文档内容

@Controller(value = "/enterprise")public class EnterpriseController {    @ApiOperation(value = "企业列表", notes = "根据当前页码和页面显示个数来查询企业信息")    @ApiImplicitParams({            @ApiImplicitParam(required = false, name = "currentPage", value = "当前页", dataType = "Integer"),            @ApiImplicitParam(required = false, name = "size", value = "每页条数", dataType = "Integer")    })    @RequestMapping(value = "/list")    @ResponseBody    public Page<Enterprise> getEnterpriseList(@RequestParam int currentPage, @RequestParam int size) {        return null;    }}

4.启动项目后访问http://localhost:8080/swagger-ui.html

到这简单的swagger就整合到项目中了。