idcf-boat-house/boat-house

REST设计注意

Closed this issue · 0 comments

1.对于前端纯表单(非node服务)的提交方式,仅支持POST和GET方式
2.设计的API要考虑公开还是内部使用的方式,如果公开的API在设计返回错误的时候需要在400的body添加错误代码以及错误信息,如果非公开,考虑简单设计,仅返回请求错误的提示信息就可以,前端直接拿到错误信息进行提示,无需在做任务处理
3.一般REST设计会使用GET/POST/PUT/DELETE方式,其他请求的方式可能会存在不兼容的情况
4.返回响应的结果数据建议都要加上时间戳,有助于后续业务的扩展性,比如分页,倒计时等策略,类似
{
"data": {},
"timestamp": 1585040740
}