swagger驼峰命名规范

女爷i 2022-05-24 11:10 331阅读 0赞

1 ApiModel编写

/**
     *作者 : iechenyb<br>
     *类描述: 变量名不能全大写，使用小驼峰命名<br>
     *创建时间: 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请求

![70][]

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

3 postman模拟

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

![70 1][]

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

![70 2][]

4 具体的驼峰规范

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

[70]: /images/20220524/3ed1d98899454f2f952629f7dcb3c5d7.png
[70 1]: /images/20220524/eb9b22b9bfc44ceab022ba38757344d6.png
[70 2]: /images/20220524/b026aec9df7049a8a27b950cee5a76ae.png
[https_baike.baidu.com_item_7794053_fr_aladdin]: https://baike.baidu.com/item/%E9%AA%86%E9%A9%BC%E5%91%BD%E5%90%8D%E6%B3%95/7794053?fr=aladdin