RESTFul-API.md

RESTFul API

基本知识

定义

RESTFul API是一种API的设计风格，以资源为基础

RESTFul API对资源的操作即CURD，可通过HTTP请求方法体现

HTTP请求方法知识

限制条件

• 客户端-服务端(分离)
• 无状态：服务端不保存状态
• 可缓存性
• 统一接口：使用HTTP方法表示对资源的不同操作，用URI来标识资源
• 分层系统：通过约束组件行为来分层组织架构，每个组件都无法看到其他组件
• 按需代码

具体规范

1. 不用大写字母，所有单词使用英文且小写。
2. 连字符用中杠"-"而不用下杠"_"
3. 正确使用 "/"表示层级关系,URL的层级不要过深，并且越靠前的层级应该相对越稳定
4. 结尾不要包含正斜杠分隔符"/"
5. URL中不出现动词，用请求方式表示动作
6. 资源表示用复数不要用单数(例：使用/users而不是/getUser)
7. 不要使用文件扩展名

其它注意点

1. 一般嵌套层数最好不超过两层