一般RESTful 的 API 接口, 应该返回什么参数

发布于 2022-09-01 19:23:17 字数 36 浏览 14 评论 0

状态码 备注 消息内容

3 个么 ..

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

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

发布评论

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

评论(6

枯叶蝶 2022-09-08 19:23:18

我目前使用的参数大概就是这三个了。。。
状态(执行成功或者失败或者异常等等)
说明(便于调试,在代码里也有类似注释的感觉,也方便写文档)
内容(实际有价值的数据)

蓬勃野心 2022-09-08 19:23:18

info主要存放内容,即请求端需要的数据
response_status 有成功和失败
msg 请求成功为空,失败则解释请求为何失败,逻辑或者少传参数,等等。

{
    "info": {
        "extra": null,
        "data":"ba8ec027040b58ba55f52b07514f948e"
    },
    "response_status": "success",
    "msg": ""
}
我为君王 2022-09-08 19:23:18

http method和status code有定规,至于实际内容处理header里面常规的那些,真正的Rest响应内容里面最需要的实际是链接,超媒体才是Rest应用数据的核心。

苏辞 2022-09-08 19:23:18

code message data

老子叫无熙 2022-09-08 19:23:18

之前用code,message,data 后来发现不管是用http status code 或者是自定义code 都很费劲,就换成status,message,data 状态只有成功和错误两种,提示倚重message了,不过客户端要做多语言或者自定义信息就不是那么方便了,各有利弊。

浮萍、无处依 2022-09-08 19:23:18

格式统一有好处。但我偏向选择精简的格式,去掉所有多余的部分。就如登陆请求的成功,那就返回200表示成功了,

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