swagger驼峰命名规范

1 ApiModel编写

/**
 *作者 : iechenyb
*类描述: 变量名不能全大写,使用小驼峰命名
*创建时间: 2018年5月25日20:47:10 */ @ApiModel(description="swagger命名规范") public class BaseRQ { @ApiModelProperty(value="功能号",name="F",example="getUser") private String f;//纯大写不能生成 @ApiModelProperty(value="请求唯一标记",name="ID",example="99") private String id; @ApiModelProperty(value="aaaCdDe",example="aaaCdDe") private String aaaCdDe;//小驼峰命名 @ApiModelProperty(value="bbbBbbCdDe",example="bbbBbbCdDe") private String bbbBbbCdDe;//小驼峰命名 @ApiModelProperty(value="userName",example="userName") private String userName;//小驼峰命名 @ApiModelProperty(value="qDate",notes="qDate",example="qDate") private String qDate;//小驼峰命名 @ApiModelProperty(value="ADate",notes="ADate",example="ADate") private String ADate;//大驼峰命名-常用与类名 @ApiModelProperty(value="AaaBbbCcc",example="AaaBbbCcc") private String AaaBbbCcc;//大驼峰命名-常用与类名 @ApiModelProperty(value="ABCD",example="ABCD") private String ABCD;//纯大写命名(不符合驼峰) }


2 swagger生成post请求

swagger驼峰命名规范_第1张图片

注意:虽然swagger生成的变量名与后台定义的model的属性不同,但是不影响值得传递。

3 postman模拟

直接用swagger生成的json数据格式请求,响应效果如下:

swagger驼峰命名规范_第2张图片

将非驼峰命名的变量名改成与后端定义的bean的属性名相同,则后台无法获取正确额属性值。

swagger驼峰命名规范_第3张图片

4 具体的驼峰规范

https://baike.baidu.com/item/骆驼命名法/7794053?fr=aladdin

你可能感兴趣的:(环境搭建)