[Spring Boot + Swagger]后端并不想与你说话并向你扔出一个接口文档链接

背景

最近在做一个Spring Boot的项目，接口写的差不多了，后续大概要和前端对接。众所周知后端和前端的沟通是非常耗时和费力的，这时候有一个完善的接口文档会带来很大的帮助。Swagger就是一个非常好的选择。

---

添加依赖

Gradle工程添加如下依赖：

    compile("io.springfox:springfox-swagger-ui:2.6.1")
    compile("io.springfox:springfox-swagger2:2.6.1")

Maven工程添加如下依赖：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.6.1</version>
    <scope>compile</scope>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.6.1</version>
    <scope>compile</scope>
</dependency>

——————

修改代码

为Applicaion类添加Swagger的注解：

@SpringBootApplication
@EnableSwagger2
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

创建一个配置类，防止将Spring默认的错误处理等接口放入文档中。

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2).select()
                .apis(Predicates.not(RequestHandlerSelectors.basePackage("org.springframework.boot")))
                .build();
    }
}

---

结果

启动应用，访问"/swagger-ui.html",查看接口文档。

甚至可以直接测试接口。

感想

还是要善于使用各种开发工具。