restful 风格项目,返回值 json 该如何设计 ?

发布于 2022-09-02 19:29:13 字数 244 浏览 7 评论 0

一般来说restful风格的返回值该如何 ? 有哪些基本 key ?
比如类似 :

{
    status : "",
    metadata:{
        
    },
    content:{
    []
    },
    error:"",
    success:""
}

如何设计,才能使在 web客户端方便而且统一的获取,不然每个地方的格式都不一样的话就很麻烦了 ?

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

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

发布评论

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

评论(2

眼眸里的那抹悲凉 2022-09-09 19:29:13

我目前做法是:
data:接口返回的数据
code:错误代码
ret:请求是否成功/请求是否抛出异常
forUser:前端展示给用户看的信息
forWorker:给工作人员看的信息
version:版本号
这个返回格式跟个人习惯还有团队的之间的协商很有关系,一般来说除了几个必须的重要的信息,例如数据、错误代码,其他都是看情况的。

睫毛溺水了 2022-09-09 19:29:13
code: 错误代码比如  0为正常  非0为异常
data: 接口返回的数据
msg:  错误信息
~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文