在 json 模式中，如何定义一个枚举并描述枚举中的每个元素？

Question

在 json 模式中，我可以简单地使用“enum”和可用代码列表定义代码列表，例如：

{
  "type": "object",
  "properties": {
    "group": {
      "type":"string",  
      "$ref": "#/definitions/Group"
    }
  },

  "definitions": {
    "Group": {
      "enum": ["A","B"]
    }
  }
}

以下有效负载将是有效的：

{
  "group": "B"
}

但是，我尝试向用户提供架构中的描述，其中“A”=“A 组”，“B”=“B 组”。就像是：

{
  "type": "object",
  "properties": {
    "group": {
      "type":"string",  
      "$ref": "#/definitions/Group"
    }
  },

  "definitions": {
    "Group": {
      "enum": [
        {"code":"A",
         "description": "Group A"
        },
        {"code":"B",
         "description": "Group B"
        }
      ]
    }
  }
}

但我不想改变有效负载的结构（不需要“描述”字段）描述更多的是用于用户可以参考的文档目的。这里有可以使用的好做法吗？

谢谢

Answer 1

您可以使用anyOfwithconst来代替enum. 然后您可以使用title或description作为文档。

{
  "anyOf": [
    {
      "const": "A",
      "title": "Group A"
    },
    {
      "const": "B",
      "title": "Group B"
    }
  ]
}