需要说明Rest API响应设计

时间:2018-07-17 05:00:29

标签: node.js api

我们有一个REST API,需要从一开始就使用。让我们说

URL: https://domain/method/param
header:
{Authorization:'' }

现在,其余api的响应位于json数组中,如下所示:

[{"a": 1, "b": 2}]

我的查询:

  1. 以上回复格式是否正确(我对此表示怀疑)?
  2. 因为即使API返回的状态代码为200,我也无法获取数据。因此,这是API的问题还是我的代码中要做的事情。我只是简单地使用节点js的请求api来使用此服务。

在我看来,响应应该是单个JSON对象,例如:

{data :[{"a": 1, "b": 2}]}

因此,为了进一步理解,我在代码中和通过邮递员添加了响应的屏幕截图。

response when hitting through code

response when hitting through postman

2 个答案:

答案 0 :(得分:1)

没有修复响应或错误JSON对象,但是您可以根据自己的喜好创建自己的对象。

在下面,我向您展示了我在开发其余API时使用的响应和错误对象

  

成功响应对象

 {
   "code" : 200, (any success code 201,301)
   "data" : object or array 
 }
  

错误响应对象

 {
   "code" : 404, (any error code 400,422,500)
   "error" : "error message"
 }

我在这里获取了代码,您也可以将状态设置为true或false。

答案 1 :(得分:0)

JSON仅作为JSON返回,因此数组本身将像在第二个视图中一样进行配对。那是你在问什么吗?