家具网站建设需求,网站建设的需求要素,樟木头网站推广,域名注册哪个网站最便宜1. 所有请求使用POST方法 使用post#xff0c;相对于get的query string#xff0c;可以支持复杂类型的请求参数。例如日常项目中碰到get请求参数为数组类型的情况。 便于对请求和响应统一做签名、加密、日志等处理
2. URL规则 URL中只能含有英文#xff0c;使用英文单词或…1. 所有请求使用POST方法 使用post相对于get的query string可以支持复杂类型的请求参数。例如日常项目中碰到get请求参数为数组类型的情况。 便于对请求和响应统一做签名、加密、日志等处理
2. URL规则 URL中只能含有英文使用英文单词或简称不要使用汉语拼音 所有字符使用小写字母 多个单词之前使用连字符-分隔如third-login, 不要使用thirdlogin,thirdLogin或third_login URL的path部分使用 系统/模块/操作 的格式如 ims/video/list 系统表示这个接口是微服务中的哪个服务可使用简称模块表示系统的子模块。模块名字使用名词全称且使用单数形式操作表示具体的接口使用动词名词的形式需要考虑单复数。比如add-user,list-users,delete-users
3. HTTP头部
将具体业务无关的数据放在HTTP headers后端系统可以在不涉及请求和响应体的情况下处理一些公用逻辑
4. 请求和响应体
使用utf-8编码JSON格式如果需要加密可以将正常的JSON加密后用base64编码
5. HTTP状态码
业务的处理结果不体现在http状态码由响应体的错误码字段表示只是有部分http状态码表示业务无关的响应例如 200: 业务已处理但是处理成功还是失败由响应体表示400: 错误的请求多用在请求参数验证。客户端开发要保证向服务器提交正确格式的请求401: 认证失败一般没有token或者没有token过期403: 没有权限调用这个接口。客户端应该隐藏用户无权限的操作500: 服务器异常
6. 字段命名
JSON来自javascript语言所以字段命名遵循javascript语言使用 lowerCamelCase 小骆驼拼写法不要使用下划线链接的 snake_case
7. 数据类型
常用数据类型映射
bool映射为 string使用Y表示trueN表示falseint: 映射为numberlong: 映射为string因为js的number类型能处理的数值范围不够实际项目中会导致各种奇怪的问题float, double, decimal: 映射为string日期、时间:映射为string
注意
表示ID概念的字段统一使用string数据传输时如果某个字段为空值直接省略这个字段不传减少网络开销响应体业务数据包含多个数据结构时优先使用嵌套格式,例如下面这个用户创建的消息item: {num_iid: 520813250866,title: 三刃木折叠刀过安检创意迷你钥匙扣钥匙刀军刀随身多功能小刀包邮,desc_short: ,price: 25.8,total_price: 0,suggestive_price: 0,orginal_price: 25.80,nick: 欢乐购客栈,num: 832,min_num: 0,detail_url: http://item.taobao.com/item.htm?id520813250866,pic_url: //img.alicdn.com/imgextra/i4/2596264565/TB2p30elFXXXXXQXpXXXXXXXXXX_!!2596264565.jpg,brand: 三刃木,brandId: 4036703,rootCatId: 50013886,cid: 50014822,favcount: 4824,fanscount: 1469,crumbs: [],created_time: ,modified_time: ,delist_time: ,
8. 响应体格式
code 业务处理的错误码使用简短的能够体现错误种类的英文单词表示使用大写字母使用下划线分隔单词。不建议用数字表示错误码用数字表示需要额外维护错误码表。
