Restful是web API 的一种规范! 用例:dingo/api
10大规范
- API与用户的通信协议,用HTTPS
- 命名规范:https://api.xx.com或https://xx.com/api
- 版本规范:
https://xx.com/api/v1 https://xx.com/api/v2 - 数据即资源
https://xx.com/api/v1/book https://xx.com/api/v1/books - 不同的method控制不同的操作
GET:https://xx.com/api/v1/books 列表资源 GET:https://xx.com/api/v1/books/1 一个资源 POST:https://xx.com/api/v1/books 新增资源,返回相应资源 PUT:https://xx.com/api/v1/books 编辑资源全部信息,返回相应资源 PATCH:https://xx.com/api/v1/books 编辑资源部分信息,返回相应资源 DELETE:https://xx.com/api/v1/books 删除资源,返回空 - 过滤:
https://xx.com/api/v1/books?limit=10:指定返回记录的数量 - 状态码:
200-成功,201-创建成功 301-永久重定向,302-暂时重定向 403-请求无权限,404-请求路径不存在,405-请求方法不存在 参考HTTP/1.1: Status Code Definitions - 返回code,message
{
code:0,
message:''
} - 结果返回,可以是全链接
{
code:0,
message:'success',
data:{
url:'https://www.xx.com/111.png'
}
}
|