高并发秒杀项目——API接口文档

swagger工具

Swagger是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务。目标是使客户端和文件系统作为服务器以同样的速度来更新文件的方法,参数和模型紧密集成到服务器。

搭建swagger

加入依赖

<!--swagger依赖-->
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>2.7.0</version>
</dependency>
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger-ui</artifactId>
  <version>2.7.0</version>
</dependency>

整合swagger

1、首先创建SwaggerConfig类
2、在类中加入@EnableSwagger2注解
3、添加@bean注解，然后添加一个ApiInfo的配置，添加注解扫描，其实对于扫描这里，配置分类两类，一个是包的路径扫描，一个是按照注解的扫描

public class SwaggerConfig {
   
   
    @Bean
    public Docket productApi() {
   
   
        return