swagger-api/swagger-codegen

TypeScript Fetch client doesn't support multipart/form-data body

Open

#3,921 建立於 2016年10月4日

在 GitHub 查看
 (7 留言) (13 反應) (0 負責人)HTML (12,701 star) (5,474 fork)batch import
Client: TypeScriptIssue: Bughelp wanted

描述

Description

If a POST operation accepts multipart/form-data, the typescript-fetch client posts an application/x-www-form-urlencoded body instead of form data.

Swagger-codegen version

Version currently deployed on [editor.swagger.io]

Swagger declaration file content or url
swagger: '2.0'
info: { version: 0.1.0, title: Multipart Upload }
paths:
  /:
    post:
      operationId: upload
      consumes:
        - multipart/form-data
      parameters:
        - name: file
          in: formData
          required: true
          type: file
      responses: { '200': { description: Successful upload } }
Command line used for generation

"Generate Client" -> "TypeScript Fetch" on [editor.swagger.io]

Steps to reproduce
  1. Generate and compile the sample config
  2. Call it with a file
  3. Log the request, it has a Content-Type of application/x-www-form-urlencoded instead of multipart/form-data.
Suggest a Fix

Instead of setting the Content-Type and using querystring to serialize the contents (for multipart/form-data requests), it should just set the body to an instance of FormData instead of

e.g., in DefaultApiFetchParamCreactor#upload, instead of :

let contentTypeHeader: Dictionary<string>;
contentTypeHeader = { "Content-Type": "application/x-www-form-urlencoded" };
fetchOptions.body = querystring.stringify({ 
  "file": params.file,
});
if (contentTypeHeader) {
  fetchOptions.headers = contentTypeHeader;
}

it should generate (as Content-Type is set to multipart/form-data automatically if using FormData):

const formData = new FormData();
formData.append("file", params.file);
fetchOptions.body = formData;

貢獻者指南

TypeScript Fetch client doesn't support multipart/form-data body · swagger-api/swagger-codegen#3921 | Good First Issue