跳到主要内容

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")
private Integer brandId;

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

三、配置Model的JsonNaming:

@JsonNaming(value = PropertyNamingStrategy.SnakeCaseStrategy.class)
public class Brand {

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