我们可以覆盖规范定义中给出的示例值吗?

时间:2020-06-08 01:09:18

标签: swagger swagger-ui swagger-2.0 swagger-editor

我已经在spec定义(Swagger 2.0)中定义了一个对象和一个示例值,如下所示。并且在不拘一格的用户界面中,此示例值适用于所有请求类型。

对象

SampleObject:
    type: object
    properties:
      id:
        type: string
      name:
        type: string
      value:
        type: string
      version:
        type: integer
        format: int64
      createdDate:
        type: string
      lastModifiedDate:
        type: string
      createdBy:
        type: string

示例值

example:
      id: "abc123"
      name: "Sample Name"
      value: "Sample Value"
      version: 0
      createdDate: "2020-05-23T18:22:55.527+00:00"
      lastModifiedDate: "2020-05-24T19:28:21.125+00:00"
      createdBy: "Sand"

对于帖子请求正文,我希望用户仅填写名称和值属性,因为其他值是由后端自动生成的。因此,我只想看到name和value属性,就像我在post request正文中给出的示例值一样。有什么方法可以覆盖仅针对特定邮寄请求的定义中给出的定义?还是所有邮寄请求类型?

0 个答案:

没有答案