M
Published on
· Last modified on
· Public

HTTP API设计指南 学习笔记

Request

  1. 状态码:
  • 200:对于GET DELETE PATCH请求同步地成功
  • 201:对于POST请求同步地成功
  • 202:对于POST DELETE PATCH请求异步地成功
  • 206:对于GET只是部分异步完成 更多
  1. 一种使用curl来调用的例子 curl -X DELETE https://service.com/apps/1f9b/domains/0fd4

  2. 允许JSON出现在请求中 curl -X POST https://service.com/apps -H "Content-Type: application/json" -d '{"name": "demoapp"}'

  3. 使用小写的路径名和属性名,路径中可以用连字符("-")连接,属性可以使用下划线("_")来区分单词

Response

  1. 如果没有特别的理由,总是提供UUID,这个可以用来追踪请求和应答,例: "id": "01234567-89ab-cdef-0123-456789abcdef"
  2. 提供标准时间戳,包括createdat和updatedat,另外用ISO8601格式,例: "finished_at": "2012-01-01T12:00:00Z"
  3. 对于外键用嵌套的形式,例: { "name": "service-production", "owner": { "id": "5d8201b0..." }, ... } 而不要 { "name": "service-production", "owner_id": "5d8201b0...", ... } 这样写一个好处是,后面如果你要扩展owner字段会比较方便,只需要在下面继续加字段就行了
S
Published on

已星,求星。

M
Published on

已星

C
Published on

已星,求星

B
Published on

已星,求星

H
Published on

已星,求星

P
Published on

求星 已星

N
Published on

求星 已星

Sign in or Sign up Leave Comment