API 404 页面的最佳实践
Best practice for 404 page for API
我正在编写 REST API。我遇到了一个问题 - api 中的 404 页面应该是什么样子。
当然，向用户 link 展示 API 文档会更好。
但是一般的页面呢。
它应该是漂亮的页面还是只是简单的文本也采用 JSON 或 XML 格式。
如果页面有很多 images/scripts，我们不得不低效地使用网络连接。
当然，我们只能获得 headers 的 http 响应，但这似乎是一个糟糕的解决方案。
我查看了几个 well-known API 以及它们如何实现 404 页面的方式。
Flickr 和 Twitter 都有 404 个包含图片的页面，css。
但是 Github 的响应非常简单，只是 JSON 以及以下内容。
{
"message": "Not Found",
"documentation_url": "https://developer.github.com/v3"
}
我认为这是一个很好的响应示例（没有图像和css）如果不正确请纠正我。
所以我的问题是 404 API 响应的最佳实践是什么，它应该非常简单（比如 GitHub）还是最好添加一些关于 API。
先谢谢大家了。
如果有人请求 API，他们很可能会捕获 404 异常并查找 HttpStatusCode。如果是 404，他们不需要更多信息，只需报告找不到用户 (?)。
所以你做什么并不重要，因为 99% 的请求甚至不会下载响应站点
404 Not Found API 中的响应根本不需要包含任何内容。客户端代码在查看请求内容之前可能会查看状态代码。
到目前为止，我编写的每个 REST 客户端代码都不关心 404 Not Found 响应的主体。除了找不到资源这一事实之外，我无法想象正文中有任何用处。
我正在编写 REST API。我遇到了一个问题 - api 中的 404 页面应该是什么样子。
当然，向用户 link 展示 API 文档会更好。
但是一般的页面呢。
它应该是漂亮的页面还是只是简单的文本也采用 JSON 或 XML 格式。
如果页面有很多 images/scripts，我们不得不低效地使用网络连接。
当然，我们只能获得 headers 的 http 响应，但这似乎是一个糟糕的解决方案。
我查看了几个 well-known API 以及它们如何实现 404 页面的方式。
Flickr 和 Twitter 都有 404 个包含图片的页面，css。
但是 Github 的响应非常简单，只是 JSON 以及以下内容。
{
"message": "Not Found",
"documentation_url": "https://developer.github.com/v3"
}
我认为这是一个很好的响应示例（没有图像和css）如果不正确请纠正我。
所以我的问题是 404 API 响应的最佳实践是什么，它应该非常简单（比如 GitHub）还是最好添加一些关于 API。
先谢谢大家了。
如果有人请求 API，他们很可能会捕获 404 异常并查找 HttpStatusCode。如果是 404，他们不需要更多信息，只需报告找不到用户 (?)。 所以你做什么并不重要，因为 99% 的请求甚至不会下载响应站点
404 Not Found API 中的响应根本不需要包含任何内容。客户端代码在查看请求内容之前可能会查看状态代码。
到目前为止，我编写的每个 REST 客户端代码都不关心 404 Not Found 响应的主体。除了找不到资源这一事实之外，我无法想象正文中有任何用处。