GET请求 - 参数或Accept标头中所需的响应格式

Question

我正在开发一个ASP.Net Web API 2 RESTful Web服务,用于从我的数据库导入和导出数据.对于我的导出方法,客户端有几个选项可以导出不同格式的数据(例如pdf,xml等).我正在尝试确定我的界面的最佳设计,以便客户端通知服务提供数据的格式.

据我所知,我的2个最佳选择是使用带有媒体类型字符串的Accept Header或向客户端可以在查询字符串中提供format参数的方法添加参数.如果我选择使用Accept Header,则可能涉及使用自定义媒体类型字符串.

在我看来,使用Accept Header将更符合HTTP标准和RESTful实践,但在查询字符串中使用format参数将更容易在服务端和客户端上实现.

任何人都可以解释这两种设计的一些优点或缺点是什么？

Answer 1

您的两种方法都是获得相同结果的有效方法。REST 不是要实现的规范，因此您在这里得到的任何响应都可能是某人的首选方式或他们如何理解 REST。

您的问题与程序员的问题类似。SE：通过 Accept header 与扩展进行内容协商之间的权衡。另请注意，pdf、xml 等具有标准的可识别 mime 类型，因此我认为不需要自定义媒体类型字符串。

话虽这么说，我获取报告的首选方法是使用?format=pdf查询字符串。选择更容易、更易于维护、更干净等的东西。