一、 Swagger简介与优势

Swagger是一个有力巨大的API文档和测试工具，它能帮开发者轻巧松创建和维护API文档。用Swagger，您能飞迅速构建、测试和发布API，搞优良开发效率。据打听，超出80%的API开发团队用Swagger进行API文档的创建。

二、 安装与配置Swagger

要用Swagger，先说说需要在项目中添加依赖。以Spring Boot为例， 您能在pom.xml中添加以下依赖：

    io.springfox
    springfox-swagger2
    2.9.2


    io.springfox
    springfox-swagger-ui
    2.9.2

接着，在Spring Boot的主类上添加@EnableSwagger2注解，以启用Swagger支持。

@SpringBootApplication
@EnableSwagger2
public class Application {
    public static void main {
        SpringApplication.run;
    }
}

在application.properties或application.yml文件中，添加如下配置，以定义API文档的标题、说说、版本等信息：

swagger:
  title: My API
  description: My awesome API
  version: 1.0.0
  contact:
    name: My Team
    url: https://myteam.com
    email: 

四、创建API文档

在Spring Boot项目中，您能用Swagger注解来定义API文档。

@RestController
@RequestMapping
@Api
public class PersonController {
    @ApiOperation
    @GetMapping
    public List getAll {
        // ...
    }
    @ApiOperation
    @ApiImplicitParam
    @GetMapping
    public Person getById {
        // ...
    }
    // ... 其他方法
}

五、 用Swagger-UI进行接口调试

启动Spring Boot项目后访问http://localhost:8080/swagger-ui.html，即可看到生成的API文档和Swagger-UI界面。在这里您能测试API接口，查看响应后来啊，以及生成API客户端代码。

本文观点。