API 404页的最佳做法

Question

我现在正在编写REST API。 我面临一个问题-api中的404页面应该是什么样子。
当然，向用户显示指向API文档的链接会更好。
但是页面一般如何。
它是漂亮的页面还是JSON或XML格式的简单文本。
如果页面上有很多图像/脚本，我们必须低效地使用网络连接。 当然，我们只能获得http响应的标头，但这似乎是一个不好的解决方案。

我研究了几种著名的API，以及它们如何实现404页的方式。

Flickr和Twitter都有404页，其中包含一些图片，即CSS。

但是Github的响应非常简单，只是带有以下内容的JSON。

{
  "message": "Not Found",
  "documentation_url": "https://developer.github.com/v3"
}

我认为这是一个很好的回应示例（没有图片和CSS），否则请纠正我。

因此，我的问题是404 API响应的最佳做法是什么（应该很简单（如在GitHub上），还是最好添加一些有关API的有用信息）。

提前谢谢大家。

Answer 1

如果有人请求API，他们很可能会捕获404异常并寻找HttpStatusCode。 如果是404，他们不需要更多信息，只需报告未找到用户（？）。 因此，您执行的操作并不重要，因为99％的请求甚至都不会下载响应网站

Answer 2

API中的404 Not Found响应根本不需要任何内容​​。 客户端代码可能会先查看状态代码，然后再查看请求的内容。

到目前为止，我编写的每个REST客户端代码都不关心404 Not Found响应的内容。 我无法想象任何东西在没有找到资源的事实之上还有任何用途。