swagger-ui中的编码未爆炸requestBody中的属性

时间:2019-01-04 08:32:56

标签: rest swagger swagger-ui openapi

该参数未分解为单独的字段,我无法理解原因。

这是我的Yaml,使用OpenApi 3.0

paths:
  /match/started:
    post:
      tags:
        - match
      summary: 'Callback for when a game has started.'
      operationId: 'App\Http\Controllers\Api\V1\MatchController::started'
      requestBody:
        description: 'Something something batman!'
        required: true
        content:
          multipart/form-data:
            schema:
              required:
                - match_uuid
              properties:
                game_uuid:
                  type: string
                player_uuids:
                  type: array
                  items:
                    type: string
              type: object
            encoding:
              player_uuids:
                style: form
                explode: true
      responses:
        200:
          description: 'success response'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Api_V1_Match_Started'

这是sw着嘴给我的卷曲请求( Bad

curl -X POST "https://editor.swagger.io/api/v1/match/started" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "game_uuid=test" -F "player_uuids=aaa,bbb,ccc"

您可以看到最后一个参数是-F "player_uuids=aaa,bbb,ccc",它应该是-F "player_uuids=aaa" -F "player_uuids=bbb" -F "player_uuids=ccc"

因此完整的请求应如下所示:

curl -X POST "https://editor.swagger.io/api/v1/match/started" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "game_uuid=test" -F "player_uuids=aaa" -F "player_uuids=bbb" -F "player_uuids=ccc"

1 个答案:

答案 0 :(得分:1)

当前无法使用OpenAPI定义场景(具有分解数组的多部分请求),因为explodestyle行为仅为application/x-www-form-urlencoded定义,而没有为{ {1}}:

  

multipart/*
  ...如果请求正文媒体类型不是style,则将忽略此属性。

     

application/x-www-form-urlencoded
  ...如果请求正文媒体类型不是explode,则将忽略此属性。

相关讨论:Swagger UI: Submit An Array of Integer Elements In formdata

您可能想file an enhancement request使用OpenAPI规范。

相关问题