fix: put requests with application/x-www-form-urlencoded is incorrectly handled

Author: iandyh

.changeset/fix-form-urlencoded-put.md

@@ -0,0 +1,8 @@
+---
+"swagger-typescript-api": patch
+---
+
+Fix: PUT requests with application/x-www-form-urlencoded content type
+
+This fixes an issue where PUT requests with `application/x-www-form-urlencoded` content type were incorrectly sent as `multipart/form-data`.
+A new `createUrlEncoded` method has been added to the `HttpClient` to handle this content type correctly.

src/schema-routes/schema-routes.ts

@@ -561,21 +561,48 @@ export class SchemaRoutes {
       });
     }
 
-    if (routeParams.formData.length) {
-      contentKind = CONTENT_KIND.FORM_DATA;
+    if (
+      contentKind === CONTENT_KIND.URL_ENCODED &&
+      routeParams.formData.length
+    ) {
       schema = this.convertRouteParamsIntoObject(routeParams.formData);
       content = this.schemaParserFabric.getInlineParseContent(
         schema,
         typeName,
         [operationId],
       );
-    } else if (contentKind === CONTENT_KIND.FORM_DATA) {
-      schema = this.getSchemaFromRequestType(requestBody);
+    } else if (routeParams.formData.length) {
+      contentKind = CONTENT_KIND.FORM_DATA;
+      schema = this.convertRouteParamsIntoObject(routeParams.formData);
       content = this.schemaParserFabric.getInlineParseContent(
         schema,
         typeName,
         [operationId],
       );
+    } else if (contentKind === CONTENT_KIND.URL_ENCODED) {
+      schema = this.getSchemaFromRequestType(requestBody);
+      content = this.schemaParserFabric.schemaUtils.safeAddNullToType(
+        requestBody,
+        this.getTypeFromRequestInfo({
+          requestInfo: requestBody,
+          parsedSchemas,
+          operationId,
+          defaultType: "any",
+          typeName,
+        }),
+      );
+    } else if (contentKind === CONTENT_KIND.FORM_DATA) {
+      schema = this.getSchemaFromRequestType(requestBody);
+      content = this.schemaParserFabric.schemaUtils.safeAddNullToType(
+        requestBody,
+        this.getTypeFromRequestInfo({
+          requestInfo: requestBody,
+          parsedSchemas,
+          operationId,
+          defaultType: "any",
+          typeName,
+        }),
+      );
     } else if (requestBody) {
       schema = this.getSchemaFromRequestType(requestBody);
       content = this.schemaParserFabric.schemaUtils.safeAddNullToType(
@@ -1074,6 +1101,12 @@ export class SchemaRoutes {
         security: hasSecurity,
         method: method,
         requestParams: requestParamsSchema,
+        type:
+          requestBodyInfo.contentKind === CONTENT_KIND.FORM_DATA
+            ? "multipart/form-data"
+            : requestBodyInfo.contentKind === CONTENT_KIND.URL_ENCODED
+              ? "application/x-www-form-urlencoded"
+              : undefined,
 
         payload: specificArgs.body,
         query: specificArgs.query,

templates/base/http-clients/axios-http-client.ejs

@@ -99,6 +99,22 @@ export class HttpClient<SecurityDataType = unknown> {
       }, new FormData());
     }
 
+    protected createUrlEncoded(input: Record<string, unknown>): URLSearchParams {
+      if (input instanceof URLSearchParams) {
+        return input;
+      }
+      return Object.keys(input || {}).reduce((searchParams, key) => {
+        const property = input[key];
+        const propertyContent: any[] = (property instanceof Array) ? property : [property]
+
+        for (const formItem of propertyContent) {
+          searchParams.append(key, this.stringifyFormItem(formItem));
+        }
+
+        return searchParams;
+      }, new URLSearchParams());
+    }
+
     public request = async <T = any, _E = any>({
         secure,
         path,
@@ -120,6 +136,10 @@ export class HttpClient<SecurityDataType = unknown> {
           body = this.createFormData(body as Record<string, unknown>);
         }
 
+        if (type === ContentType.UrlEncoded && body && body !== null && typeof body === "object") {
+          body = this.createUrlEncoded(body as Record<string, unknown>);
+        }
+
         if (type === ContentType.Text && body && body !== null && typeof body !== "string") {
           body = JSON.stringify(body);
         }

tests/__snapshots__/extended.test.ts.snap

@@ -6376,7 +6376,7 @@ export class Api<
         method: "POST",
         body: data,
         secure: true,
-        type: ContentType.FormData,
+        type: ContentType.UrlEncoded,
         ...params,
       }),
 
@@ -69452,7 +69452,7 @@ export class Api<
         method: "POST",
         body: data,
         secure: true,
-        type: ContentType.FormData,
+        type: ContentType.UrlEncoded,
         ...params,
       }),
 

tests/__snapshots__/simple.test.ts.snap

@@ -3968,7 +3968,7 @@ export class Api<
         method: "POST",
         body: data,
         secure: true,
-        type: ContentType.FormData,
+        type: ContentType.UrlEncoded,
         ...params,
       }),
 
@@ -43623,7 +43623,7 @@ export class Api<
         method: "POST",
         body: data,
         secure: true,
-        type: ContentType.FormData,
+        type: ContentType.UrlEncoded,
         ...params,
       }),
 

tests/spec/axios/__snapshots__/basic.test.ts.snap

@@ -2037,6 +2037,23 @@ export class HttpClient<SecurityDataType = unknown> {
     }, new FormData());
   }
 
+  protected createUrlEncoded(input: Record<string, unknown>): URLSearchParams {
+    if (input instanceof URLSearchParams) {
+      return input;
+    }
+    return Object.keys(input || {}).reduce((searchParams, key) => {
+      const property = input[key];
+      const propertyContent: any[] =
+        property instanceof Array ? property : [property];
+
+      for (const formItem of propertyContent) {
+        searchParams.append(key, this.stringifyFormItem(formItem));
+      }
+
+      return searchParams;
+    }, new URLSearchParams());
+  }
+
   public request = async <T = any, _E = any>({
     secure,
     path,
@@ -2063,6 +2080,15 @@ export class HttpClient<SecurityDataType = unknown> {
       body = this.createFormData(body as Record<string, unknown>);
     }
 
+    if (
+      type === ContentType.UrlEncoded &&
+      body &&
+      body !== null &&
+      typeof body === "object"
+    ) {
+      body = this.createUrlEncoded(body as Record<string, unknown>);
+    }
+
     if (
       type === ContentType.Text &&
       body &&

tests/spec/axiosSingleHttpClient/__snapshots__/basic.test.ts.snap

@@ -2037,6 +2037,23 @@ export class HttpClient<SecurityDataType = unknown> {
     }, new FormData());
   }
 
+  protected createUrlEncoded(input: Record<string, unknown>): URLSearchParams {
+    if (input instanceof URLSearchParams) {
+      return input;
+    }
+    return Object.keys(input || {}).reduce((searchParams, key) => {
+      const property = input[key];
+      const propertyContent: any[] =
+        property instanceof Array ? property : [property];
+
+      for (const formItem of propertyContent) {
+        searchParams.append(key, this.stringifyFormItem(formItem));
+      }
+
+      return searchParams;
+    }, new URLSearchParams());
+  }
+
   public request = async <T = any, _E = any>({
     secure,
     path,
@@ -2063,6 +2080,15 @@ export class HttpClient<SecurityDataType = unknown> {
       body = this.createFormData(body as Record<string, unknown>);
     }
 
+    if (
+      type === ContentType.UrlEncoded &&
+      body &&
+      body !== null &&
+      typeof body === "object"
+    ) {
+      body = this.createUrlEncoded(body as Record<string, unknown>);
+    }
+
     if (
       type === ContentType.Text &&
       body &&