指定 JSON api 的正确方法

Question

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

如果实体属于“类型 1”，则 parameter_1 始终为 null，而 parameter_2 是附加子参数的对象。

如果实体属于“类型 2”，则 parameter_1 为整数，而 parameter_2 不存在。我的问题是，在这种情况下，将 parameter_2 设置为 null 还是将所有子参数设置为 null 是否是一个好习惯？我会在下面给你一个更具体的例子。

'类型 1' 对象：

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

描述“类型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 最佳实践，哪一个更可取？谢谢。

Answer 1

看起来您正在将两个不同的“模式”强加为一个。如果您没有其他限制，请考虑将它们分成两个不同的资源。