RESTFUL API的最佳实践包含如下几个方面:
1、HTTP动词:POST:创建;PUT:更新;GET:查询;DELETE:删除;
2、状态码(每一个HTTP请求都应该制定状态码):
404:资源没有找到
400:参数错误(参数校验不通过);
200:GET查询资源成功
201:POST创建资源成功;
202:PUT更新成功(请求已经发送,服务器没有处理);
401:未授权;
403:当前资源被禁止;
500:未知错误;
3、错误码:自定义的错误代号;
4、统一的错误描述:错误码、错误信息、当前URL(这个错误是访问那个接口时发生的);
5、使用Token的令牌来授权和验证身份(自己存储和管理比较灵活);
6、接口版本控制();
7、测试和生产环境分开:api.xxx.com(生产)
•Dev.api.xxx.com(测试)
8、URL:语义明确;
9最好是有一份比较标准的文档。
网友评论