SpringBoot集成Swagger

前言

作为后端开放人员，最烦的事就是自己写接口文档和别人没有写接口文档，不管是前端还是后端开发，多多少少都会被接口文档所折磨，前端会抱怨后端没有及时更新接口文档，而后端又会觉得编写接口文档太过麻烦。Swagger 可以较好的接口接口文档的交互问题，以一套标准的规范定义接口以及相关的信息，就能做到生成各种格式的接口文档，生成多种语言和客户端和服务端的代码，以及在线接口调试页面等等。只需要更新 Swagger 描述文件，就能自动生成接口文档，做到前端、后端联调接口文档的及时性和便利性。

一、简介

官网：https://swagger.io/

Swagger 是一个规范且完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

Swagger 的目标是对 REST API 定义一个标准且和语言无关的接口，可以让人和计算机拥有无须访问源码、文档或网络流量监测就可以发现和理解服务的能力。当通过 Swagger 进行正确定义，用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与为底层编程所实现的接口类似，Swagger 消除了调用服务时可能会有的猜测。
 

SpringBoot集成Redis

一、引入依赖

    
            com.github.xiaoymin
            knife4j-spring-boot-starter
            3.0.2
        

二、编写配置文件

@Configuration
@EnableOpenApi
public class SwaggerConfig {
    @Bean
    public Docket apiDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xp.controller")) // 指定API的扫描路径
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Swagger--练习项目")
                .description("Swagger--练习项目")
                .version("1.0.0")
                .build();
    }
}

三、编写controller和注解

@RestController
@RequestMapping("/api")
@Api(tags = "标准演示接口")
public class ApiController {
    @Resource
    private ObjectMapper mapper;

    @PostMapping("/test")
    @ApiOperation(value = "测试请求体接口", notes = "演示json参数是否接受成功")
    public CartItem test(@ApiParam(name = "接收json参数", defaultValue = "{\n" +
            "  \"productId\": \"\",\n" +
            "  \"goodName\": \"\",\n" +
            "  \"number\": 1,\n" +
            "  \"price\": 1,\n" +
            "  \"cartId\": \"\"\n" +
            "}")

                       @RequestBody CartItem cartItem) throws IOException {
        cartItem.setPrice(50L);
        System.out.println(cartItem);
        return cartItem;
    }
}

 四、如果传参是Body实体，需要在实体类型的属性上加上属性注解：

@Data
@AllArgsConstructor
@NoArgsConstructor
@ApiModel("商品参数实体类")
public class CartItem {
   @ApiModelProperty("商品Id")
   private String productId;
   @ApiModelProperty("商品名称")
   private String goodName;
   @ApiModelProperty("商品编号")
   private Integer number;
   @ApiModelProperty("商品价格")
   private Long price;
   @ApiModelProperty("购物车Id")
   private String cartId;

}

 四、浏览器输入网址：http://localhost:8081/doc.html，看效果

五：测试接口

这个的使用与postman基本类似

这样一来，程序启动后，接口文档就自动生成了。前端人员直接访问网址就可以进行联调接口了，省去了大量的编写接口文档的时间,大大提升了工作效率.

本期分享就到这，感谢大家观看。