REST:日志数据格式的建议

时间:2016-02-29 14:09:08

标签: json rest

我有一个可以返回日志数据的服务。基本上,api类似于logs?from=1/1/15,结果是给定日期的所有日志行。

问题是这可能是巨大的数据。假设客户端可以下载它,如果它是在xml / json中,那么将其解析为DOM将需要大量内存或使客户端崩溃。使用SAX或pull解析器需要客户端提供大量非平凡的代码。

最简单的方法是将每个日志行作为json行而不换行,然后客户端可以通过换行符中断输入,甚至在接收数据时执行此操作。

这是一种标准的做事方式吗?这里的哑剧类型是什么?

1 个答案:

答案 0 :(得分:1)

我认为这是分页的好例子。您有一组资源(日志行),并且您需要它们的一部分。让他们指定一个偏移量和一个限制,并为他们提供你想要支持的任何格式的许多行(json,csv,等等)。这将使客户能够灵活地获取尽可能多的数据,因为它们可以轻松处理,并且可以让您将线条划分为合理的属性(日期,消息等)。

我非常乐于依赖JSON中的换行来查找记录边界。空格明确无意以这种方式使用。

MIME类型取决于您。如果是JSON,那么application/jsonapplication/vnd.whatever+json