RESTful API 的错误返回有什么最佳实践么？

[9]

用 http status code 来表示错误类型这个是没问题的，主要是纠结于这个之外的错误信息怎么处理展示，求指导

[v1024]

code + message ， code 用于程序判断， message 用于显示输出。 code 是 int ， message 是任意内容的 string 。

[learnshare]

遵循 HTTP code 就是比较好的实践方式。

[tidezyc]

http status code 应该保持都是 200 不变，消息里加上 code

[9]

@v1024 如果错误比较复杂， message 怕 hole 不住，或许 docker 的这种比较好？

{
"errors:" [
{
"code": <error code>,
"message": "<error message>",
"detail": ...
},
...
]
}

[9]

@learnshare http status code 这个没什么异议，我纠结的是错误信息的展示

[9]

@v1024 笔误， hole -> hold

[9]

@tidezyc 错误消息呢？

[learnshare]

@9 错误信息建议是可读懂的内容，在国内就直接输出中文好了。因为这部分是给 API 使用者或者用户看的，越清晰易懂越好。

[hbkdsm]

可以参考 JSON API 规范

[cxbig]

基本网络错误用对应的 response code
app 相关操作错误用 200 返回，基本 field 可以包括
- exception // 错误类
- code //自编错误代码
- message // 用户可见错误信息

[9]

@hbkdsm 非常感谢，相当好的参考，可惜没有评论置顶功能

发现上面提到的 docker registry 的返回结构已经跟这个规范非常接近

[9]

@learnshare 你说的我明白，我想知道的是错误的具体的展示规范，不过也很感谢你的回答！

[learnshare]

@9 你是想问 API 数据格式该如何展示对吧，可以参考

http://open.iqiyi.com/lib/OAuth2.html
https://www.instagram.com/developer/authentication/
http://www.django-rest-framework.org/
https://github.com/TryGhost/Ghost/wiki/%5BWIP%5D-API-Documentation

这些

[jade88]

为什么错误不用 4xx 返回呢