web-dev-qa-db-ja.com

Swaggerを使用してパラメーターとして配列を指定する

配列をパラメーターとして指定するにはどうすればよいですか?たとえば、/ peopleへの投稿には、username、firstname、lastnameの文字列、および配列myArrayを指定できます。

paths:
  /persons:
    post:
      parameters:
        - name: person_what_is_the_purpose_of_this
          in: body
          description: The person to create.
          schema:
            required:
              - username
            properties:
              firstName:
                type: string
              lastName:
                type: string
              username:
                type: string
              myArray:
                type: array
                  items:
                    properties:
                      myArrayElement:
                        type: string
      responses:
        200:
          description: A list of Person
          schema:
            type: array
            items:
              required:
                - username
              properties:
                firstName:
                  type: string
                lastName:
                  type: string
                username:
                  type: string
8
user1032531
swagger: "2.0"
info:
  version: "1.0.0"
  title: Swagger Petstore
Host: petstore.swagger.io
basePath: /v2
schemes:
  - http
paths:
  /pets/findByStatus:
    get:
      parameters:
        - in: query
          name: status
          type: array
          items:
            type: string
      responses:
        "200":
          description: successful operation
          schema:
            type: array
            items:
              type: object
              required:
                - name
                - photoUrls
              properties:
                id:
                  type: integer
                  format: int64
                category:
                  type: object
                  properties:
                    id:
                      type: integer
                      format: int64
                    name:
                      type: string
                name:
                  type: string
                  example: doggie
                photoUrls:
                  type: array
                  items:
                    type: string
                tags:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: integer
                        format: int64
                      name:
                        type: string
        "400":
          description: Invalid status value
7
user1032531

collectionFormat: multiを指定する必要があります

配列は次のようになります。必ずタイプと同じレベルに配置してください。

myArray:
  type: array
  collectionFormat: multi

配列に関するドキュメント

0
stepotronic