如果内容类型不同，请显示REST文档application/json

如果客户端Content-Type不是application/json，那么显示特定REST资源的文档是一个好主意吗？我的意思是，如果开发人员尝试在浏览器中获取REST资源URL，他会得到类似于this的内容。如果内容类型不同，请显示REST文档application/json

来源

2012-12-25 speechkey

虽然这是开放的讨论，但在我看来这将是一个坏主意。 RESTful API的全部用途是公开您的应用程序接口供其他开发人员使用。有些开发人员会查看http标题，以确定您的REST API的某个路由是否存在，而与内容类型无关。如果我要求提供文本/纯文本，我希望如果您没有它，并且不是200/OK文档，我会收到404/NotFound。尽管如此，我认为它可能对浏览器的手动API测试有用。

来源

2012-12-25 16:36:04 Infinity

是的，你的观点已经发生在我身上。对于使用浏览器测试API，您可以简单地在浏览器中更改Content-Type并对其进行测试，并且通常甚至不会尝试将API与除application/json以外的Content-Type一起使用。但是，如果你尝试它，没问题，你会得到文档，看看你为什么错了。 – speechkey

让我说我写了一个程序来请求您的api上的文本/纯文本内容类型，并在成功（200 /好）我想要它存入$ 100到用户帐户，否则不要。在你的情况下，即使该路线不存在，它也会返回（200/ok）。在大规模应用程序中，开发人员必须处理大量不同的RESTful API，您不能指望他们为您的代码量身定制代码。请注意，它是与您的API交互的程序;所以，它不能说“哦，那个页面上有一个文档”。 – Infinity

好吧，你是对的。如果得到一个Ok，但这个动作的结果与HTTP状态代码相反，这是不好的。它肯定以媒体类型错误结束（415）。 – speechkey

如果内容类型不同，请显示REST文档application/json

回答

相关问题