列表端点的媒体类型

Media Types for list endpoints

我有一个 REST 应用程序,其端点 return 单个项目和相同类型项目的页面。

假设单项端点具有如下 media/content 类型: application/vnd.company.myitem-1+json

我们目前也有页面结构本身的内容类型,如下所示: application/vnd.company.mylist-1+json

我真的很想能够指定列表是的列表,但是我一直没能找到一个可以接受的方式来表示它是一个[= application/vnd.company.myitem-1+json 的 11=]。有什么好的方法可以做到这一点,还是我完全找错了树?

  1. 您可以在 vendor tree part 的单个组件中对列表和条目类型进行编码,例如

    application/vnd.company.mylist1-myitem1+json application/vnd.company.mylist1-otheritem1+json

如果您的项目类型列表类型已经包含破折号,您可能必须选择其他分隔符。

  1. 或者您可以简单地在

    中传输列表类型

    Content-Type: application/vnd.company.mylist-1+json

header 并为项目类型使用不同的类型,例如

X-Item-Content-Type: application/vnd.company.myitem-1+json

项目类型。

  1. 编辑: Nick 选择的解决方案是(如评论中所述)将项目类型添加为参数,例如

    application/vnd.company.mylist-1+json;项目类型=vnd.company.myitem-1