使用友好的JSON输出

用户在第一次看到你的API使用情况，很可能是在命令行下使用curl进行的。友好的输出会让他们非常容易的理解你的API，为好开发者们的方便,打印友好的JSON输出, 例如:

  1. {
  2.   "beta": false,
  3.   "email": "alice@heroku.com",
  4.   "id": "01234567-89ab-cdef-0123-456789abcdef",
  5.   "last_login": "2012-01-01T12:00:00Z",
  6.   "created_at": "2012-01-01T12:00:00Z",
  7.   "updated_at": "2012-01-01T12:00:00Z"
  8. }

而不是这样 例如:

  1. {"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"}

记住要在每行尾部包含一个换行，这样那些使用终端测试API的输出不会被遮挡住。

对于大多数的API友好的响应数据输出总会有更好的表现，你可能受到过不友好打印数据API的影响(例如:非常高的流量占用) 或者是在一些客户端上不能工作 (例如：一个随意编写的程序).