- 尽量在http header 中放置 Accept 来判断内容类型和版本 戳这里
Accept: application/vnd.heroku+json; version=3
- 如果需要根据状态返回数据 可以添加ETag 用户可以在随后的请求中通过提供 If-None-Match头的值来检查内容是否过期。
- 如果需要跟踪请求 可以在头中 添加 Request-Id
- 在请求的reponse中可以返回对应资源
- 使用JSON传输数据
$ curl -X POST https://service.com/apps \
-H "Content-Type: application/json" \
-d '{"name": "demoapp"}'
{
"id": "01234567-89ab-cdef-0123-456789abcdef",
"name": "demoapp",
"owner": {
"email": "username@example.com",
"id": "01234567-89ab-cdef-0123-456789abcdef"
},
...
}
- 为资源生成一个UUID提供给客户端 不要使用数字 尤其是递增id
"id": "01234567-89ab-cdef-0123-456789abcdef"
- 使用 UTC（世界标准时间）时间，用 ISO8601 进行格式化
- 发生错误的时候返回可阅读的错误信息
