web-dev-qa-db-ja.com

単純なオブジェクトを持つ配列のSwaggerでモデルを記述する方法は？

私はREST文書化するサービスを持っています、それらのいくつかは次のような単純な配列を受け入れます：

[
  { "name":"a" },
  { "name":"b" },
  { "name":"c" }
]

Swaggerモデルセクションでこれをどのように説明しますか？次のような「名前付き配列」のみを作成できます

model {
properties: { "arr": { "type":"array", ......

しかし、それは次のようなデータを記述します：

"arr": [
  { "name":"a" },
  { "name":"b" },
  { "name":"c" }
]
restswaggerswagger-ui
42
razor

トニー・ユエンは近かったが、葉巻はなかった。これは、OpenAPI/SwaggerでYAMLを使用した適切な定義です。

  /test:
post:
  summary: test 123
  description: test 123
  parameters:
    - name: param1
      in: body
      required: true
      description: test param1
      schema:
          $ref: '#/definitions/stackoverflow'
  responses:
    200:
      description: OK

これにより、以下が生成されます。

stackoverflow2[
  {
     name: string
  }
]

トニーの例は以下を生成します。

[
  stackoverflow { 
                 name: string
  }
]

Swagger/OpenAPIをYAMLとして完了（コピー＆ペースト）

    swagger: '2.0'

################################################################################
#                              API Information                                 #
################################################################################
info:
  version: "Two-point-Oh!"
  title: Simple objects in array test
  description: |
    Simple objects in array test

################################################################################
#                                   Parameters                                 #
################################################################################

paths:
  /test:
    post:
      summary: Array with named objects
      description: Array with named objects
      parameters:
        - name: param1
          in: body
          required: true
          description: test param1
          schema:
            type: array
            items:
              $ref: '#/definitions/stackoverflow'
      responses:
        200:
          description: OK
  /test2:
    post:
      summary: Array with simpel (nameless) objects
      description: Array with simpel (nameless)  objects
      parameters:
        - name: param1
          in: body
          required: true
          description: test param1
          schema:
              $ref: '#/definitions/stackoverflow2'
      responses:
        200:
          description: OK
definitions:
  stackoverflow:
    type: object
    properties:
      name:
        type: string
        description: name of the object
  stackoverflow2:
    type: array
    items:
      type: object
      properties:
        name:
          type: string
          description: name of the object

Swagger/OpenAPIのJSONバージョンです

    {
  "swagger" : "2.0",
  "info" : {
    "description" : "Simple objects in array test\n",
    "version" : "Two-point-Oh!",
    "title" : "Simple objects in array test"
  },
  "paths" : {
    "/test" : {
      "post" : {
        "summary" : "Array with named objects",
        "description" : "Array with named objects",
        "parameters" : [ {
          "in" : "body",
          "name" : "param1",
          "description" : "test param1",
          "required" : true,
          "schema" : {
            "type" : "array",
            "items" : {
              "$ref" : "#/definitions/stackoverflow"
            }
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK"
          }
        }
      }
    },
    "/test2" : {
      "post" : {
        "summary" : "Array with simpel (nameless) objects",
        "description" : "Array with simpel (nameless)  objects",
        "parameters" : [ {
          "in" : "body",
          "name" : "param1",
          "description" : "test param1",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/stackoverflow2"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK"
          }
        }
      }
    }
  },
  "definitions" : {
    "stackoverflow" : {
      "type" : "object",
      "properties" : {
        "name" : {
          "type" : "string",
          "description" : "name of the object"
        }
      }
    },
    "stackoverflow2" : {
      "type" : "array",
      "items" : {
        "$ref" : "#/definitions/stackoverflow2_inner"
      }
    },
    "stackoverflow2_inner" : {
      "properties" : {
        "name" : {
          "type" : "string",
          "description" : "name of the object"
        }
      }
    }
  }
}
17
Asgair

これを http://editor.swagger.io/#/ に貼り付け、「この操作を試す」をクリックします

{
  "swagger": "2.0",
  "info": {
    "version": "1.0.0",
    "title": "Privacy-Service API"
  },
  "paths": {
    "/allNames": {
      "post": {
        "consumes": [
          "application/json",
          "application/xml"
        ],
        "produces": [
          "application/json",
          "application/xml"
        ],
        "parameters": [
          {
            "name": "request",
            "in": "body",
            "schema": {
              "$ref": "#/definitions/ArrayOfNames"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "List of names",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  },
  "definitions": {
    "ArrayOfNames": {
      "type": "array",
      "items": {
        "minItems": 1,
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string"
          }
        }
      }
    }
  }
}
9
user1778602

おそらく次のようになります。

    ...
    "parameters" : [{
      "name" : "whatEverThatArrayCalled",
      "type" : "array",
      "items" : {
        "$ref" : "whatEverThatArrayCalled"
      }
      ...
    }],
    "models" : {
   {
    "id" : "whatEverThatArrayCalled",
    "properties": 
        {
       "whatEverThatArrayCalled" :
            {
         "type" : "array",
         "items":{"name":"a",
                  "name":"b",
                  "name":"c"
                  },

             }
         }
    }
 }

...

6
Meruemu

あなたが言及した配列のフォーマットを考慮する

[
  { "name":"a" },
  { "name":"b" },
  { "name":"c" }
]

次の形式を使用できると思います。

paths:
  /test:
    post:
      description: Test request
      operationId: test
      parameters:
        - in: body
          name: requestParameter
          required: true
          schema:
            type: array
            items:
              properties:
                name:
                  type: string
      responses:
        '200':
          description: Success response
2
Nagaraj subramanian

Editor.swagger.ioで以下を試してみましたが、この質問の要求を満たし、動作します。 POSTリクエストボディには配列が必要です。配列は 'stackoverflow'アイテムで構成されています。各アイテムは、nameプロパティを持つオブジェクトです。

paths:
  /test:
    post:
      summary: test 123
      description: test 123
      parameters:
        - name: param1
          in: body
          required: true
          description: test param1
          schema:
            type: array
            items:
              $ref: '#/definitions/stackoverflow'
      responses:
        200:
          description: OK
definitions:
  stackoverflow:
    type: object
    properties:
      name:
        type: string
        description: name of the object
2
Dongminator
  parameters:
  - name: "items"
    in: "formData"
    description: "description"
    required: "true"
    type: "array"
    items:
      type: "object"
      additionalProperties:
        properties:
          name:
            type: "string"

彼らのドキュメント https://swagger.io/docs/specification/data-models/dictionaries/ によると、これはnameという名前のプロパティを持つオブジェクトと配列であり、データ型は文字列です。
リクエスト本文、たとえばrequest.body.items

更新：

（追加プロパティなしで）行うのに十分なようです：

items:
  type: object
  properties:
    name:
      type: string

これで、それぞれが名前と呼ばれるキーと対応する値を持つアイテムを取得しました。

これであれば、TOが求めていたものは...

1
Gobliins