服务接口设计必备技能
2019-04-17 17:59:17 51 举报AI智能生成
微服务接口设计高级技能
作者其他创作
大纲/内容
代码质量
单元测试
自动化测试
Coding style
基本规范
通用参数
version
比如，V1.0--
比如，V1.0--
token-令牌
path命名规范
尽量使用“-”代替下划线“_“
使用小写字母
响应数据格式
状态码：如5xx
错误码：如1001
字段命名规范
用String作为字段类型
上传/下载接口
字段：除了file，还有md5
避免浮点型数据
浮点型：BigDecimal
Json数据保持良好结构
编程语言
HttpClient
OkHttp
Rerofit
性能优化
合并接口
md5缓存
字段精简
无用字段清理
输入
输出
字段精简，如orderDesc
无用字段不必下发
图片裁剪服务
局部刷新
瘦客户端
客户端只负责展示逻辑，不处理业务逻辑
客户端不处理金额的计算
客户端少处理请求参数的校验与约束提示
扩展性
图片尽量由后端下发
配置信息由接口进行下发
数据列表化、灵活可配
flag替换boolean
"flag":"7"// 二进制：111，表示3个状态都为true
安全性
响应数据：包含用户隐私的字段，需要加*处理
请求参数：包含用户隐私的字段参数，加密传输
参数签名匹配：以防篡改
F-E安全
CSRF/XSS
Same-origin Policy
ADsafe/caja/Sandbox
兼容性
接口调整、修改需谨慎
系统外部接口调用
熟悉系统对外暴露接口
系统版本交替升级考量
MD5缓存兼容性
详细的接口文档，可以帮助新人快速熟悉业务
api文档的质量直接反应了一个公司的技术水平，甚至一个公司的文化气质
![[※]数据湖功能架构](https://www.processon.com/chart_image/template/thumb/657eaf769a873e50f506e2b7.png?tid=607ce17a1e08534f372ac63a)
0 条评论
下一页
