怎样写出靠谱的RESUTful API接口？

请求比特币历史数据的接口，公网的开发接口，无需认证。

 1 {
 2     "status": {
 3         "timestamp": "2021-02-08T06:19:27.474Z",
 4         "error_code": 0,
 5         "error_message": null,
 6         "elapsed": 12,
 7         "credit_count": 0,
 8         "notice": null
 9     },
10     "data": {
11         "id": 1,
12         "name": "Bitcoin",
13         "symbol": "BTC",
14         "quotes": [
15             {
16                 "time_open": "2021-02-06T00:00:00.000Z",
17                 "time_close": "2021-02-06T23:59:59.999Z",
18                 "time_high": "2021-02-06T16:02:41.000Z",
19                 "time_low": "2021-02-06T00:00:37.000Z",
20                 "quote": {
21                     "USD": {
22                         "open": 38138.38833975,
23                         "high": 40846.54690329,
24                         "low": 38138.38833975,
25                         "close": 39266.01073494,
26                         "volume": 71326033652.98,
27                         "market_cap": 731192490092.84,
28                         "timestamp": "2021-02-06T23:59:59.999Z"
29                     }
30                 }
31             }
32         ]
33     }
34 }

可以看到里面有 status, data 两部分，status 里面有 error_code, error_message，出错了是什么情况，啥错误信息。

 

 

 

 

思路点拨

文档效果是上面的样子，每一个参数，每一种状态码都详细解释，这些都要在代码里实现。所以说写接口看似简单的基本功，但要写出靠谱的接口，工作量不小，前期合理的规划不能少。

 10 点 RESTful 设计指南：

  1. 协议
  2. 域名
  3. 版本（Versioning）
  4. 路径（EndPoint）
  5. HTTP 动词
  6. 过滤信息（Filtering）
  7. 状态码（Status Code）
  8. 错误处理（Error Handling）
  9. 返回结果
  10. Hypermedia API

 

posted @ 2021-04-16 19:58  鲨鱼辣椒′  阅读(478)  评论(0)  编辑  收藏  举报