RESTful API设计原则

RESTful API设计原则

1）唯一专用名词表示原则

在REST风格的URI设计中，资源是一个实体，统一使用名词表示，且该名词应保证在本API系统中的唯一性。

2）分层独立性原则

每一个符合REST风格的API都应该是分层独立的，分层是指每个API都是内部封装的，其交互范围限制在单个层。

3）安全性原则

RESTful API的数据安全性原则是指调用者在执行对数据库的操作指令时，系统检测该数据库是否提供该操作，对于风险性操作执行操作限制、备份保护、日志记录、风险提示等。

4）无状态原则

无状态原则是指服务器端不保存客户端请求的状态(如session、cookie等)，即客户端每次发起的请求是崭新的、独立的。

5）版本兼容原则

API的更新应尽量保持与原版本的兼容，并以不同的版本标识，版本号应放入URI， 易于标识和调用。

6）执行结果一致性原则

该原则针对API返回结果的信息一致性进行设计，即服务器执行API后的返回数据中包含请求参数、请求地址、返回状态码、返回信息、成功信息、失败信息和执行结果等信息，便于调用者自检，确定执行参数和返回结果的正确性。

7）缓存原则

REST使用缓存设计原则，执行频率较高的API应缓存以提升加载速度，缓存分为临时缓存和长久缓存两个部分，对于某一时刻调用较高的API缓存至内存中，对于长期调用频率较高的API缓存至硬盘。