RESUful
- 协议 https
- HTTP动词
HTTP动词 | SQL命令 | 含义 |
---|
GET | SELECT | 从服务器取出资源(一项或多项)。 |
POST | CREATE | 在服务器新建一个资源。 |
PUT | UPDATE | 在服务器更新资源(客户端提供改变后的完整资源)。 |
PATCH | UPDATE | 在服务器更新资源(客户端提供改变的属性)。 |
DELETE | DELETE | 从服务器删除资源。 |
HEAD | | 获取资源的元数据。 |
OPTIONS | | 获取信息,关于资源的哪些属性是客户端可以改变的。 |
3. 状态码(Status Codes)
状态码 | 意义 | HTTP动词 | 含义 |
---|
200 | OK | GET | 服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。 |
201 | CREATED | POST/PUT/PATCH | 用户新建或修改数据成功。 |
202 | Accepted | * | 表示一个请求已经进入后台排队(异步任务)。 |
204 | NO CONTENT | DELETE | 用户删除数据成功。 |
400 | INVALID REQUEST | POST/PUT/PATCH | 用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。 |
401 | Unauthorized | * | 表示用户没有权限(令牌、用户名、密码错误)。 |
403 | Forbidden | * | 表示用户得到授权(与401错误相对),但是访问是被禁止的。 |
404 | NOT FOUND | * | 用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。 |
406 | Not Acceptable | GET | 用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。 |
410 | Gone | GET | 用户请求的资源被永久删除,且不会再得到的。 |
422 | Unprocesable entity | POST/PUT/PATCH | 当创建一个对象时,发生一个验证错误。 |
500 | INTERNAL SERVER ERROR | * | 服务器发生错误,用户将无法判断发出的请求是否成功。 |
4. 返回结果
HTTP动词 | 示例 | 含义 |
---|
GET | /collection | 返回资源对象的列表(数组) |
GET | /collection/resource | 返回单个资源对象 |
POST | /collection | 返回新生成的资源对象 |
PUT | /collection/resource | 返回完整的资源对象 |
PATCH | /collection/resource | 返回完整的资源对象 |
DELETE | /collection/resource | 返回一个空文档 |
参考地址http://www.ruanyifeng.com/blog/2014/05/restful_api