Swagger使用需要注意什么?

  根据7.0架构及规范中对参数规范的要求,swagger使用要注意以下几点:

一、配置jackson为蛇形格式

  spring.jackson.property-naming-strategy=SNAKE_CASE

  此项配置不用开发人员单独调整,需要统一在配置中心的application.yml中配置:

  spring:

  datasource:

  url:jdbc:mysql://localhost:3306/v641?

  ....

  jackson:

  property-naming-strategy:SNAKE_CASE

二、配置Model中的属性的name值

  @ApiModelProperty(required=true,value="品牌id",name="brand_id")

  privateIntegerbrandId;

  即:name="brand_id"这段,来保证当model做为controller的入参时swagger显示正确

三、配置Model的JsonNaming:

  @JsonNaming(value=PropertyNamingStrategy.SnakeCaseStrategy.class)

  publicclassBrand{

  即在类上加入@JsonNaming注解,指明细蛇形解析,以达到向客户端输出时,属性解析为蛇形规则。

  本文由易族智汇javashop整理讲述Swagger使用需要注意什么,希望可以帮助每一位读者。

本文由易族智汇(Javashop)原创,首发于易族学院。欢迎转载,请注明出处并保留原文链接:https://www.javamall.com.cn/xueyuan/ 商务咨询:400-089-8805

留言与评论(共有 0 条评论)
   
验证码: