用戶第一次查看你的 API 很可能是在使用 curl 的命令行里。如果 API 的響應(yīng)有良好的打印格式,那在命令行里它們會(huì)很容易理解。為了給這些開(kāi)發(fā)者提供方便,良好打印格式的 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 結(jié)尾有換行,以防止阻塞用戶的終端界面。
對(duì)于大部分 API 的響應(yīng),性能考濾要優(yōu)先于良好打印。在某些結(jié)點(diǎn)(例如高流量結(jié)點(diǎn))或?yàn)槟承┨囟ㄓ脩簦ɡ鐭o(wú)GUI界面的程序)使用時(shí),你可能會(huì)考濾使用高性能而非良好打印的 API。
注:headless program 譯為“無(wú)顯示界面的程序”,參考自這篇文章.