接口管理工具Swagger

什么是Swagger？

Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTfull风格的Web服务，是非常流行的API表达工具。

Swagger有什么作用？

Swagger能够自动生成完善的RESTful API文档，同时并根据后台代码的修改同步更新，同时提供完整的测试页面来调试API。

在项目中引入Swagger相关依赖

在pom.xml中添加以下代码

        <!-- 添加 swagger2 相关功能 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <!-- 添加 swagger-ui 相关功能 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

添加完成后点击下载依赖

配置Swagger

@Configurable  // 告诉 Spring 容器，这个类是一个配置类
@EnableSwagger2  // 启动 Swagger2 功能
public class swaggerConfig {
    /**
     * 配置 Swagger2 相关的 bean
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com"))   // com包下所有API都交给 Swagger2 管理
                .paths(PathSelectors.any()).build();
    }

    /**
     * 此处主要是 API 文档页面显示信息
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("演示项目API")   // 标题
                .description("演示项目")  // 描述
                .version("1.0")    // 版本
                .build();
    }
}

这是一个模板，可以不用修改，项目需要使用的话直接复制过去就可以了

使用Swagger2进行接口测试

启动项目→访问http://localhost:8080/swagger-ui.html，即可打开自动生成的可视化测试页面

启动项目出错

修改服务器端口即可

Swagger弹窗错误

暂时还没解决