18. Spring Boot 配置swagger文档管理

swagger是一种强大的REST接口管理系统，通过简单的配置，即可以将系统提供的REST接口以丰富的可视化形式展示给用户使用。

1. 添加依赖

要在Spring Boot中配置这个功能，首先需要增加如下其依赖。依赖分为两个部分。

      
            io.springfox
            springfox-swagger2
            2.2.2
        
        
            io.springfox
            springfox-swagger-ui
            2.2.2
        

2. 使能swagger的配置类

新增一个Swagger 的配置类，使用@Configuration注解和@EnableSwagger2注解该类，即可以实现一个最小化的无侵入Swagger配置。此时，打开http://localhost:8080/上下文/swagger-ui.html就能够进行访问。

当然，由于是最小化的配置，不可避免的这个文档不够人性化。包含了大量的系统内部REST服务等，也缺乏友好的交互页面。

为了能简单优化一下这个页面，我们对这个配置类进行简单的配置。

@Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("org.liyubo.lianlizhicore.controller"))  // 扫描指定的地方，不要引入一堆系统服务
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2构建 RESTful APIs")
                .description("对系统功能的简单描述")
                .termsOfServiceUrl("#")
                .contact("作者信息")
                .version("1.0")
                .build();
    }

另外，为了让每个服务能够友好的显示其功能。可以再在RSET的响应上，通过@ApiOperation(value="系统用户信息更新接口", notes="")注解进行更为详细的介绍。

3. 最终形成的一个基本效果

最终效果