抱歉，我不用别的测试工具了！

大家好，我是鱼皮。

大多数后端开发程序员的工作都是写接口（服务），比如 HTTP、RPC 等等，供前端或其他系统来调用。写接口的过程中必然会考虑两个问题：

如何对接口进行测试，保证接口质量？
如何搞出接口文档，减少沟通成本？

先说说测试，一般情况下，除了本地对某个方法进行单元测试外，我们还要用 curl、postman 等工具来发送请求进行接口测试，但需要手动编写请求的信息，比较麻烦。

再说说接口文档，说白了，就是要以书面的形式介绍你接口的功能、地址、调用方法、请求参数、响应结构、细节等等，从而明确接口的信息，推动合作。但手动编写接口文档无疑会消耗大量的时间，因此很多时候，大家选择口口相传，开局一张嘴，正确与否全靠脸。

那有没有什么方法，可以自动帮助我们生成接口文档，并且不用手动编写请求信息就能测试呢？

当然有！Swagger 就是这样一款知名的接口文档生成工具，相信学 Java 的朋友对它不会陌生。

地址：https://swagger.io/

它支持多种编程语言，且用法异常简单！以 Java SpringBoot 项目为例，只需要先在项目中引入它的 SDK，Maven 项目参考代码如下：

代码语言：javascript复制

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

然后编写一个 Java Bean 来定义 Swagger 的配置，包括作者名、文档名称、自动生成的接口所在路径等，参考代码如下：

代码语言：javascript复制

@Configuration
@EnableSwagger2WebMvc
// 生产环境记得关闭哦
@Profile({"dev", "test"})
public class SwaggerConfig {

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

  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
      .title("Swagger Document")
      .version("0.0.1")
      .build();
  }
}

然后，直接启动项目，就能自动生成一份美观的接口文档了。默认地址记得是 "/接口前缀/doc.html"，在浏览器中访问这个地址，就能看到文档页面了：