正确的方法来规范JSON api

时间:2015-06-01 10:48:54

标签: json api rest

我需要为一个可以有两种类型的实体创建CRUD json API。

如果实体属于'type 1',则parameter_1始终为null,parameter_2为其他子参数的对象。

如果实体是'type 2',则parameter_1是整数,parameter_2不存在。我的问题是,在这种情况下,将parameter_2设置为null或将所有子参数设置为null是一个好习惯吗?我将在下面给你一个例子来说明一点。

'Type 1'对象:

{
  name: 'object 1',
  parameter_1: null,
  parameter_2: {
      subparameter_1: 'somthing',
      subparameter_2: 'somthing else'
  }
}

描述'type 2'对象的两种方式:

{
  name: 'object 2',
  parameter_1: 123,
  parameter_2: null
}

{
  name: 'object 1',
  parameter_1: 123,
  parameter_2: {
      subparameter_1: null,
      subparameter_2: null
  }
}

根据REST最佳做法,哪一个更受欢迎?感谢。

1 个答案:

答案 0 :(得分:0)

看起来你强迫两个不同的模式'成一个人。如果您没有其他约束,请考虑将它们分成两个不同的资源。