Swagger 2.0:接受任何(复杂)JSON值的模式

Question

我正在编写Swagger 2.0规范的API基本上是任何JSON值的存储.

我想要一个读取值的路径和一个存储非预定义深度的任何JSON值(null,数字,整数,字符串,对象,数组)的路径.

不幸的是,似乎Swagger 2.0对输入和输出的模式非常严格,并且不允许JSON Schema允许的整套模式.Swagger编辑器不允许使用示例混合值(例如,可以是布尔值或整数的属性)或松散定义的数组(必须严格定义项的类型)和对象.

所以我正在通过定义MixedValue架构来尝试解决方法:

---
swagger: '2.0'
info:
  version: 0.0.1
  title: Data store API
consumes:
- application/json
produces:
- application/json
paths:
  /attributes/{attrId}/value:
    parameters:
    - name: attrId
      in: path
      type: string
      required: true
    get:
      responses:
        '200':
          description: Successful.
          schema:
            $ref: '#/definitions/MixedValue'
    put:
      parameters:
      - name: value
        in: body
        required: true
        schema:
          $ref: '#/definitions/MixedValue'
      responses:
      responses:
        '201':
          description: Successful.
definitions:
  MixedValue:
    type: object
    properties:
      type:
        type: string
        enum:
        - 'null'
        - boolean
        - number
        - integer
        - string
        - object
        - array
      boolean:
        type: boolean
      number:
        type: number
      integer:
        type: integer
      string:
        type: string
      object:
        description: deep JSON object
        type: object
        additionalProperties: true
      array:
        description: deep JSON array
        type: array
    required:
    - type

但扬鞭编辑拒绝松散定义object和array性质.

问题: - 有没有办法解决这个问题？ - 它只是一个Swagger编辑器错误还是Swagger 2.0规范的强大限制？ - 是否有更好的方法(最佳实践)来指定我需要的东西？ - 对于某些使用我的API规范的语言,我可以期待swagger生成的代码有一些限制吗？

Answer 1

可以像这样定义任意类型的模式:

definitions:
  AnyValue: {}

或者如果你想要description:

definitions:
  AnyValue:
    description: 'Can be anything: string, number, array, object, etc.'

没有定义type,AnyValue可以是任何东西 - 字符串,数字,布尔,数组,对象等.有关如何使用模式工作的更多详细信息,请参阅此问答type.

在OpenAPI 3.0中,您可以添加nullable: true以允许null值:

components:
  schemas:
    AnyValue:
      nullable: true
      description: Can be anything, including null.

以下是Swagger Editor 2.0如何使用AnyValue模式处理body参数:

我不知道代码生成器如何处理这个问题.