【域名】单独给一个域名或url路径(出现跨域怎么解决?) 通常使用https 【版本】不同版本需要标注 【资源】资源最好使用名词 【操作方式】不从请求链接体现操作方式,在请求方式上解决操作方式
- - get:https: // example. com/ api/ v1/ books 获取所有
- - post:https: // example. com/ api/ v1/ books 新增一本
- - put:https: // example. com/ api/ v1/ book/ 1 更新id = 1 的一本
- - patch:https: // example. com/ api/ v1/ book/ 1 更新id = 1 的一本
- - delete:https: // example. com/ api/ v1/ book/ 1 删除id = 1 的一本
【资源过滤】通过接口传参来过滤资源
- - https: // example. com/ api/ v1/ books?limit= 10 限制10 条
【错误信息】请求失败时需标注错误信息
{ "message" : "请求参数不合法" }
【操作结果】请求成功是返回结果 【子资源返回资源接口】返回的资源如果有子资源,返回子资源的链接地址,如查找书,书的封面图片就可以url表示 【方法】
GET 从服务器获取资源
POST 在服务新建资源
PUT 更新资源(完整)
PATCH 更新局部资源
DELETE 删除资源
HEAD 返回请求首部
CONNECT HTTP/ 1.1 协议中预留给能够将连接改为管道方式的代理服务器。
OPTIONS 允许客户端查看服务器的性能。
TRACE 回显服务器收到的请求,主要用于测试或诊断。