API status code 定义规范的问题

发布于 2022-09-02 01:02:42 字数 75 浏览 11 评论 0

咨询大家一个问题啊,一般在定义API的返回码(status code,包括错误码)的时候,有什么可以遵循的规范么?或者有什么要注意的地方

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

萌︼了一个春 2022-09-09 01:02:42

最好能遵守http协议,比如请求成功是200, 权限不够返回403
根据http header里的status code 足够处理了
状态码详细
http://www.restapitutorial.com/httpstatuscodes.html

200成功,body就是需要的数据

有错误时,可以返回{error: "message"}就可以,没必要自己定义一系列code

关于状态码选择
http://racksburg.com/choosing-an-http-status-code/

梦毁影碎の 2022-09-09 01:02:42

我觉得关于api这款返回code不需要那么多状态码了,常用的几个就好了,我常定义的结构如下

code:xxx,
data:xxx,
msg:xxxx

code 我一般就两个 200 和 -1 ,200表示OK,-1 就是出错了

msg返回出错信息

data是数据区域,返回api接口数据

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文