swagger-codegen - Wie stelle ich der generierten C# SDK-Methode einen Textkörper zur Verfügung?

Question

Ich verwende den (inoffiziellen) swagger-codegen-cli-Docker-Container von https://hub.docker.com/r/jimschubert/swagger-codegen-cli/, der swagger-codegen aus dem Master-Zweig zieht, bevor er ausgeführt wird. Ich habe versucht, den kürzlich dokumentierten (offiziellen) Swagger-Codegen-CLI von https://hub.docker.com/r/swaggerapi/swagger-codegen-cli/ zu greifen, aber es scheint im Moment nicht verfügbar zu sein.

wie es mit dem nicht offiziellen cli steht, habe ich einen C# SDK von swagger Dokumentation erzeugt, den Folgendes enthält:

/api/customer/{zoneId}/files/cover/gallery: { 
    get: { 
     tags: [ 
      "FileUpload" 
     ], 
     summary: "Get all files in customer cover gallery", 
     operationId: "FileUpload_GetCustomerCoverFiles", 
     consumes: [ ], 
     produces: [ 
      "application/json", 
      "text/json" 
     ], 
     parameters: [ 
      { 
       name: "zoneId", 
       in: "path", 
       description: "", 
       required: true, 
       type: "integer", 
       format: "int32" 
      } 
     ], 
     responses: { 
      200: { 
       description: "OK", 
       schema: { 
        type: "array", 
        items: { 
         $ref: "#/definitions/FileUploadGalleryItemModel" 
        } 
       } 
      } 
     } 
    }, 
    post: { 
     tags: [ 
      "FileUpload" 
     ], 
     summary: "Upload file to customer cover gallery", 
     operationId: "FileUpload_CreateCustomerCoverGalleryItem", 
     consumes: [ 
      "application/octet-stream" 
     ], 
     produces: [ 
      "application/json", 
      "text/json" 
     ], 
     parameters: [ 
      { 
       name: "zoneId", 
       in: "path", 
       description: "", 
       required: true, 
       type: "integer", 
       format: "int32" 
      }, 
      { 
       name: "payload", 
       in: "body", 
       description: "", 
       required: true, 
       type: "byte[]", 
       format: "binary" 
      } 
     ], 
     responses: { 
      200: { 
       description: "OK", 
       schema: { 
        type: "array", 
        items: { 
         $ref: "#/definitions/FileUploadGalleryItemModel" 
        } 
       } 
      } 
     } 
    } 
}, 

Die ‚Nutzlast‘ innerhalb des Körpers der Anforderung zur Verfügung gestellt, aber ich ziehe‘ Es gibt keine Möglichkeit, der Methode, die im SDK generiert wird, den Text mit der folgenden Signatur zur Verfügung zu stellen: public List<FileUploadGalleryItemModel> FileUploadCreateCustomerCoverGalleryItem (int? zoneId).

Irgendwelche Vorschläge, was ich übersehen oder falsch machen könnte?

Answer 1

Sie können stattdessen payload als Datei (Formularparameter) dokumentieren, z. https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/test/resources/2_0/petstore.yaml#L269-L273, und Sie werden Beispielcode in der automatisch generierten Dokumentation finden (bitte sehen Sie sich die automatisch generierte README.md als Ausgangspunkt an)