SpringCloudSpringBoot使用Swagger2构建强大的RESTful API文档

因为Spring Boot可以快速开发、便捷部署等特性，相信有很大一部分Spring Boot的用户会用来构建RESTful API。而咱们构建RESTful API的目的一般都是因为多终端的缘由，这些终端会共用不少底层业务逻辑，所以咱们会抽象出这样一层来同时服务于多个移动端或者Web前端。

这样一来，咱们的RESTful API就有可能要面对多个开发人员或多个开发团队：IOS开发、Android开发或是Web开发等。为了减小与其余团队平时开发期间的频繁沟通成本，传统作法咱们会建立一份RESTful API文档来记录全部接口细节，然而这样的作法有如下几个问题：

• 因为接口众多，而且细节复杂（须要考虑不一样的HTTP请求类型、HTTP头部信息、HTTP请求内容等），高质量地建立这份文档自己就是件很是吃力的事，下游的抱怨声不绝于耳。
• 随着时间推移，不断修改接口实现的时候都必须同步修改接口文档，而文档与代码又处于两个不一样的媒介，除非有严格的管理机制，否则很容易致使不一致现象。

为了解决上面这样的问题，本文将介绍RESTful API的重磅好伙伴Swagger2，它能够轻松的整合到Spring Boot中，并与Spring MVC程序配合组织出强大RESTful API文档。它既能够减小咱们建立文档的工做量，同时说明内容又整合入实现代码中，让维护文档和修改代码整合为一体，可让咱们在修改代码逻辑的同时方便的修改文档说明。另外Swagger2也提供了强大的页面测试功能来调试每一个RESTful API。具体效果以下图所示：

alt=

下面来具体介绍，若是在Spring Boot中使用Swagger2。首先，咱们须要一个Spring Boot实现的RESTful API工程，若您没有作过这类内容，建议先阅读
Spring Boot构建一个较为复杂的RESTful APIs和单元测试。

下面的内容咱们会以教程样例中的Chapter3-1-1进行下面的实验（Chpater3-1-5是咱们的结果工程，亦可参考）。

添加Swagger2依赖

在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>
复制代码

建立Swagger2配置类

在Application.java同级建立Swagger2的配置类Swagger2。

@Configuration
@EnableSwagger2
public class Swagger2 {
 
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.didispace.web"))
                .paths(PathSelectors.any())
                .build();
    }
 
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2构建RESTful APIs")
                .description("更多Spring Boot相关文章请关注：http://blog.didispace.com/")
                .termsOfServiceUrl("http://blog.didispace.com/")
                .contact("程序猿DD")
                .version("1.0")
                .build();
    }
 
}
复制代码

如上代码所示，经过@Configuration注解，让Spring来加载该类配置。再经过@EnableSwagger2注解来启用Swagger2。

再经过createRestApi函数建立Docket的Bean以后，apiInfo()用来建立该Api的基本信息（这些基本信息会展示在文档页面中）。select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展示，本例采用指定扫描的包路径来定义，Swagger会扫描该包下全部Controller定义的API，并产生文档内容（除了被@ApiIgnore指定的请求）。完整项目的源码来源 技术支持1791743380