集册 HTTP API 设计指南 良好打印的默认 JSON

良好打印的默认 JSON

欢马劈雪     最近更新时间:2020-08-04 05:37:59

431

用户第一次查看你的 API 很可能是在使用 curl 的命令行里。如果 API 的响应有良好的打印格式,那在命令行里它们会很容易理解。为了给这些开发者提供方便,良好打印格式的 JSON 如下:

{
  "beta": false,
  "email": "alice@heroku.com",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "last_login": "2012-01-01T12:00:00Z",
  "created_at": "2012-01-01T12:00:00Z",
  "updated_at": "2012-01-01T12:00:00Z"}

而不是:

{"beta":false,"email":"alice@heroku.com","id":"01234567-89ab-cdef-0123-456789abcdef","last_login":"2012-01-01T12:00:00Z", "created_at":"2012-01-01T12:00:00Z","updated_at":"2012-01-01T12:00:00Z"}

要确保在 JSON 结尾有换行,以防止阻塞用户的终端界面。

对于大部分 API 的响应,性能考滤要优先于良好打印。在某些结点(例如高流量结点)或为某些特定用户(例如无GUI界面的程序)使用时,你可能会考滤使用高性能而非良好打印的 API。

注:headless program 译为“无显示界面的程序”,参考自这篇文章.