Swagger schicken Sie Körper und formData-parameter

Ich bin mit Swagger 2.0 und ich habe ein problem senden mehrere post-Parameter. Ich habe einen Fors Fehler Operation cannot have a body parameter and a formData parameter und ich weiß nicht, wie es zu lösen ist. In meiner definition habe ich eine Körper-parameter, und diese parameter muss ein JSON-format, aber eine Seite muss ich andere parameter, wie z.B. Dateien hochladen und mit dem Namen.

Wie kann ich tun, schicken Sie Körper und formData-Parameter ?

Hier ist die web-service definition :

  /updateDatas:
    post:
      summary: Upadate datas
      description: |
        Update datas
      consumes:
        - multipart/form-data
      produces:
          - application/json
      parameters:
        - name: firstFileName
          in: formData
          description: First file name.
          required: true
          type: string
        - name: secondFileName
          in: formData
          description: Second file name.
          required: true
          type: string
        - name: datas
          in: body
          description: Json object informations.
          required: true
          schema:
            $ref: '#/definitions/Datas'
        - name: firstFile
          in: formData
          description: First file .jpg
          required: true
          type: file
        - name: clientFile
          in: formData
          description: Second file .jpg
          required: true
          type: file
      tags:
        - Application
      responses:
        '200':
          description: Uploaded
          schema:
            $ref: '#/definitions/Upload'
        '401':
          description: Unauthorized Bad Token
InformationsquelleAutor John | 2016-04-26
  1. 10

    Entsprechend der swagger Spezifikationen sehen, type:body und type:formData können nicht zusammen bestehen für die gleiche operation.

    InformationsquelleAutor aK26
  2. 8

    Einen Weg, um das problem zu beheben ist, um "Daten" als Formular-parameter mit dem Typ "Datei". Hier ist ein Beispiel:

      parameters:
    - name: petId
      in: path
      description: ID of pet to update
      required: true
      type: integer
      format: int64
    - name: additionalMetadata
      in: formData
      description: Additional data to pass to server
      required: false
      type: string
    - name: file
      in: formData
      description: file to upload
      required: false
      type: file

    Ref: https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/test/resources/2_0/petstore.yaml#L257

    UPDATE: Körper-Parameter und die Parameter form, können nicht co-existieren: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameterObject

    Körper - Die Nutzlast, die an den HTTP-request. Da kann es nur einen payload, es kann nur einen Text-parameter. Der name des body-Parameters hat keine Auswirkung auf den parameter selbst und dient der Dokumentation. Da die Parameter Form, sind auch in der Nutzlast, Körper und form-Parameter können nicht zusammen bestehen für die gleiche operation.

    • Es gibt keinen anderen Weg für den Typ 'file' ? Weil ich nicht will, so nutzen Sie eine Datei über die JSON-Daten
    • Danke!, aber was ist, wenn additionalMetadata ist ein Verweis auf eine definition?
    • Können Sie uns ein Beispiel geben von dem, was der HTTP-request-body/payload aussieht (z.B. mit gist.github.com)?
    • So das abschließende Fazit ist, dass wir nicht verwenden können beide Körper und formdata in der gleichen form. Richtig?
    • Ja, das ist richtig nach den spec.
    InformationsquelleAutor William Cheng
Schreibe einen Kommentar