Lesson-6 API 设计入门

  • 尽量在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 进行格式化
  • 发生错误的时候返回可阅读的错误信息
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,948评论 18 139
  • API定义规范 本规范设计基于如下使用场景: 请求频率不是非常高:如果产品的使用周期内请求频率非常高,建议使用双通...
    有涯逐无涯阅读 2,596评论 0 6
  • HTTP API 设计指南 前言 这篇指南介绍描述了 HTTP+JSON API 的一种设计模式,最初摘录整理自 ...
    Originalee阅读 2,818评论 0 15
  • 陌上花开 可以缓缓归矣
    不止小迷糊阅读 76评论 0 0
  • 谈恋爱之前,常常幻想着爱情里各种浪漫的场景,憧憬着将来自己也能遇到一份浪漫的爱情。当真的开始和现在的老公谈恋爱之后...
    LWJane阅读 484评论 0 0