小编Geo*_*ff 的帖子

如何在swagger中提供包含数组作为其属性之一的对象定义的示例

参考下面的例子,我想NamedElementArray在其定义中提供一个例子.这将需要示出的阵列的一个例子NamedElementelements属性.

我怎么做?我无法在swagger规范中找到如何执行此操作的详细信息.

swagger: '2.0'

info:
  version: "0.0.0"
  title: Example

definitions:
  Identifier:
    type: string
    format: uuid
  NamedElement:
    type: object
    properties:
      name:
        type: string
      identifier:
        $ref: "#/definitions/Identifier"
    required:
    - name
    - identifier
    example:
      name: Identifier1
      identifier: ab804529-11d0-4781-a49a-3bbbc40243df
  NamedElementArray:
    type: object
    properties:
      name: 
        type: string
      elements:
        type: array
        minLength: 0
        items:
          $ref: "#/definitions/NamedElement"
    required:
    - name
    - elements
    example:
      name: Fred
      elements:

paths:
  /elements/{name}:
    get:
      description: |
        Gets `NamedElement` objects, based on the **name** query param.
      parameters: …
Run Code Online (Sandbox Code Playgroud)

definitions swagger

9
推荐指数
1
解决办法
1万
查看次数

标签 统计

definitions ×1

swagger ×1