Swagger工具

Swagger的优势

1.Swagger 的 API 支持自动生成同步的在线文档：
使用 Swagger 后可以直接通过代码生成文档，不再需要自己手动编写接口文档了，对程序员来说非常方便，可以节约写文档的时间去学习新技术

2.提供 Web 页面在线测试 API：
光有文档还不够，Swagger 生成的文档还支持在线测试。参数和格式都定好了，直接在界面上输入参数对应的值即可在线测试接口。

使用Swagger

1.首先在Spring boot项目的pom.xml 导入Swagger的依赖

<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>

2.在开发的项目中配置Swagger
   位置：在主启动类同级下创建config包，并在包下创建以下的类
   配置：主要设置生成的接口文档名字，其他无需配置

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createDocket(){
        ApiInfoBuilder apiInfoBuilder=new ApiInfoBuilder();
        ApiInfo apiInfo=apiInfoBuilder.title("接口文档").build();
        Docket docket=new Docket(DocumentationType.SWAGGER_2);

        docket.apiInfo(apiInfo);
        docket.select().apis(RequestHandlerSelectors.any());
        return  docket;
    }
}

3.启动项目：
   打开以下网址就可以查看当前项目里所有的接口和生成接口的文档

http://localhost:8080/swagger-ui.html