【问题标题】:JSON Schema required attributesJSON Schema 所需属性
【发布时间】:2012-07-28 10:13:45
【问题描述】:

我试图找到一个类似的答案,但找不到,所以就这样吧:

在为一个json文档定义schema的时候,如果我们根据需要定义一个属性,这个要求是对输入数据的要求,还是对输入输出的要求? 例子: 假设我们有一个名为 Id 的属性。资源始终存在此 Id,但此 Id 由服务器生成。如果我想发布我的架构以供公众使用,并且我允许某人创建此资源的实例,是否应该根据需要定义 Id?所需的属性是否只是 API 的使用者必须发送以创建资源的属性,还是资源始终具有的所有属性,包括服务器生成的属性?

【问题讨论】:

  • 另外,我应该在架构中只定义 API 使用者可以发送的那些属性(即使是可选的),还是应该定义服务器生成的那些属性(如 dateCreated、dateUpdated 等)?
  • 您是否暗示在您的任何用例中消费者从未使用过 Id 属性,并且它是您服务器的产物?
  • Id 用作只读属性。它用于访问资源。

标签: json rest schema jsonschema


【解决方案1】:

如果您需要验证“id”键是否存在,那么您应该将其设为必需。您可以做的是有两种不同的模式:一种用于验证来自用户的模式(无“id”),一种用于验证 api 调用,一种包括“id”键

【讨论】:

    猜你喜欢
    • 2015-09-01
    • 1970-01-01
    • 1970-01-01
    • 2020-02-05
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2014-03-01
    相关资源
    最近更新 更多