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

gclove
  • 1.4k

状态码 备注 消息内容

3 个么 ..

回复
阅读 5.5k
6 个回答

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

谢远东
  • 4.4k

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

{
    "info": {
        "extra": null,
        "data":"ba8ec027040b58ba55f52b07514f948e"
    },
    "response_status": "success",
    "msg": ""
}
dhcn
  • 243

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

leaman8
  • 40

code message data

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

Archeus
  • 4
新手上路,请多包涵

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

撰写回答
你尚未登录,登录后可以
  • 和开发者交流问题的细节
  • 关注并接收问题和回答的更新提醒
  • 参与内容的编辑和改进,让解决方法与时俱进
宣传栏