RESTful内容API格式

时间:2015-10-27 19:14:54

标签: html json api rest

我正在设计一个返回文章的RESTful API; API应以什么格式返回数据,如文章内容?

文章资源限制了authorpublishedlabels等数据元素,程序员负责在其应用程序/框架/环境中进行适当的编码。

abstractcontent等受限制较少的数据元素可以包含段落,引用,图像等,因此如何在API中返回此内容以使程序员在其环境中具有灵活性?

我看到了三种广泛的解决方案:

  1. HTML;
  2. XML(或JSON);和,
  3. 自定义语法。
  4. HTML(或HTML的一个子集)对客户端程序员来说是一个挑战,因为缺乏结构和可能复杂的内容,但大多数环境都存在良好的库。

    XML格式like Atom(或某些JSON格式)提供的结构比HTML更多,对复杂内容的支持更少。 API可以复制一些结构化字段,以便在API程序员上轻松地展开数据,例如title:= atom:titleabstract:= atom:summary,和content:= atom:content。但Atom确实支持HTML内容,因此在某些方面,这与纯HTML一样具有挑战性。但是,大多数环境都存在Atom库,因此程序员可以利用这些来简化内容的处理。

    自定义语法的优点是只向程序员提供API所需的结构,但缺点是程序员必须自己处理该结构(除非我为他们的环境提供了一个库)。

    这当然是一个古老的问题,但2015年有没有优雅的解决方案?

0 个答案:

没有答案