feat(api-client): body request based on the request type and the para…

…meter BREAKING CHANGE: generator now ignores bodies for requests that should not send any body, only PUT, PATCH and POST should contain body and it is handled as optional
flowup · Dec 9, 2020 · d0309b0 · d0309b0
1 parent cdf2c6d
commit d0309b0
Show file tree

Hide file tree

Showing 12 changed files with 47 additions and 32 deletions.
diff --git a/src/parser.ts b/src/parser.ts
@@ -115,8 +115,8 @@ function parseMethods(
           const op = <Operation>operation;
           return (
             supportedMethods.indexOf(methodType.toUpperCase()) !== -1 && // skip unsupported methods
-            (!swaggerTag || (op.tags && op.tags.includes(swaggerTag)))
-          ); // if tag exists take only paths including this tag
+            (!swaggerTag || (op.tags && op.tags.includes(swaggerTag))) // if tag exists take only paths including this tag
+          );
         })
         .map(([methodType, operation]: [string, Operation]) => {
           // select the lowest success (code 20x) response
@@ -143,23 +143,38 @@ function parseMethods(
             parameters || {},
           );
 
+          const methodTypeLowered = methodType.toLowerCase() as MethodType;
+          const formData = transformedParams
+            .filter(({ name, isFormParameter }) => name && isFormParameter)
+            .map(({ name, camelCaseName }) => ({
+              name,
+              camelCaseName: camelCaseName || name,
+            }));
+          const stringifyBody = (param?: Parameter) =>
+            param ? `JSON.stringify(args.${param.camelCaseName})` : 'null';
+          const body = /^(?:post|put|patch)\b/.test(methodTypeLowered)
+            ? formData.length
+              ? 'formData'
+              : stringifyBody(
+                  transformedParams.find(
+                    ({ isBodyParameter }) => isBodyParameter,
+                  ),
+                )
+            : undefined;
+
           return {
             hasJsonResponse: true,
             methodName: toCamelCase(
               operation.operationId
                 ? !swaggerTag
                   ? operation.operationId
                   : operation.operationId.replace(`${swaggerTag}_`, '')
-                : `${methodType}_${pathName.replace(/[{}]/g, '')}`,
+                : `${methodTypeLowered}_${pathName.replace(/[{}]/g, '')}`,
             ),
-            methodType: methodType.toLowerCase() as MethodType,
+            methodType: methodTypeLowered,
+            body,
             parameters: transformedParams,
-            formData: transformedParams
-              .filter(({ name, isFormParameter }) => name && isFormParameter)
-              .map(({ name, camelCaseName }) => ({
-                name,
-                camelCaseName: camelCaseName || name,
-              })),
+            formData,
             // turn path interpolation `{this}` into string template `${args.this}
             path: pathName.replace(
               /{(.*?)}/g,

diff --git a/src/types.ts b/src/types.ts
@@ -57,6 +57,7 @@ export interface Parameter extends Property {
 
 export interface Method {
   readonly path?: string; // path appended to base in method
+  readonly body?: string; // body that will be used for post, put and patch methods
   readonly methodName?: string; // mane of the generated method
   readonly methodType?: MethodType; // type of the http method
   readonly description?: string;

diff --git a/templates/ngx-service.handlebars b/templates/ngx-service.handlebars
@@ -136,7 +136,7 @@ export class {{#if (templateType 'guardedService')}}Guarded{{&serviceName}} exte
     {{/formData}}
 
     {{/if}}
-    return this.http.{{methodType}}<{{&responseTypeSchema.type}}>(`${this.domain}${path}`{{#parameters}}{{#isBodyParameter}}, JSON.stringify(args.{{&camelCaseName}}){{/isBodyParameter}}{{/parameters}}{{#if formData.length}}, formData{{/if}}, options);{{else}}
+    return this.http.{{methodType}}<{{&responseTypeSchema.type}}>(`${this.domain}${path}`{{#if body}}, {{body}}{{/if}}, options);{{else}}
     return super.{{&methodName}}({{#if parameters.length}}args, {{/if}}requestHttpOptions, observe){{#responseGuard}}
       .pipe(tap((res: any) => {{&../responseGuard}} || console.error(`TypeGuard for response '{{&../responseTypeSchema.type}}' caught inconsistency.`, res))){{/responseGuard}};{{/if}}
   }{{else}};{{/if}}

diff --git a/tests/custom/swagger.yaml b/tests/custom/swagger.yaml
@@ -269,7 +269,6 @@ paths:
     get:
       description: Get standard File
       parameters:
-        - $ref: '#/parameters/modelParam'
         - description: Name of repository owner.
           in: path
           name: owner

diff --git a/tests/esquare/api/api-client.service.ts b/tests/esquare/api/api-client.service.ts
@@ -106,7 +106,7 @@ export class APIClient implements APIClientInterface {
       observe,
     };
 
-    return this.http.post<object>(`${this.domain}${path}`, options);
+    return this.http.post<object>(`${this.domain}${path}`, null, options);
   }
 
   /**
@@ -788,7 +788,7 @@ export class APIClient implements APIClientInterface {
       observe,
     };
 
-    return this.http.post<models.ImportResponse>(`${this.domain}${path}`, options);
+    return this.http.post<models.ImportResponse>(`${this.domain}${path}`, null, options);
   }
 
   /**
@@ -895,7 +895,7 @@ export class APIClient implements APIClientInterface {
       observe,
     };
 
-    return this.http.post<void>(`${this.domain}${path}`, options);
+    return this.http.post<void>(`${this.domain}${path}`, null, options);
   }
 
   /**
@@ -1748,7 +1748,7 @@ export class APIClient implements APIClientInterface {
       observe,
     };
 
-    return this.http.put<void>(`${this.domain}${path}`, options);
+    return this.http.put<void>(`${this.domain}${path}`, null, options);
   }
 
   /**
@@ -1781,7 +1781,7 @@ export class APIClient implements APIClientInterface {
       observe,
     };
 
-    return this.http.put<void>(`${this.domain}${path}`, options);
+    return this.http.put<void>(`${this.domain}${path}`, null, options);
   }
 
   /**

diff --git a/tests/github/api/services/gists/gists-api-client.service.ts b/tests/github/api/services/gists/gists-api-client.service.ts
@@ -731,7 +731,7 @@ export class GistsAPIClient implements GistsAPIClientInterface {
     if ('xGitHubRequestId' in args) {
       options.headers = options.headers.set('X-GitHub-Request-Id', String(args.xGitHubRequestId));
     }
-    return this.http.post<void>(`${this.domain}${path}`, options);
+    return this.http.post<void>(`${this.domain}${path}`, null, options);
   }
 
   /**
@@ -887,7 +887,7 @@ export class GistsAPIClient implements GistsAPIClientInterface {
     if ('xGitHubRequestId' in args) {
       options.headers = options.headers.set('X-GitHub-Request-Id', String(args.xGitHubRequestId));
     }
-    return this.http.put<void>(`${this.domain}${path}`, options);
+    return this.http.put<void>(`${this.domain}${path}`, null, options);
   }
 
 }
diff --git a/tests/github/api/services/markdown/markdown-api-client.service.ts b/tests/github/api/services/markdown/markdown-api-client.service.ts
@@ -148,7 +148,7 @@ export class MarkdownAPIClient implements MarkdownAPIClientInterface {
     if ('xGitHubRequestId' in args) {
       options.headers = options.headers.set('X-GitHub-Request-Id', String(args.xGitHubRequestId));
     }
-    return this.http.post<void>(`${this.domain}${path}`, options);
+    return this.http.post<void>(`${this.domain}${path}`, null, options);
   }
 
 }
diff --git a/tests/github/api/services/notifications/notifications-api-client.service.ts b/tests/github/api/services/notifications/notifications-api-client.service.ts
@@ -265,7 +265,7 @@ export class NotificationsAPIClient implements NotificationsAPIClientInterface {
     if ('xGitHubRequestId' in args) {
       options.headers = options.headers.set('X-GitHub-Request-Id', String(args.xGitHubRequestId));
     }
-    return this.http.patch<void>(`${this.domain}${path}`, options);
+    return this.http.patch<void>(`${this.domain}${path}`, null, options);
   }
 
   /**

diff --git a/tests/github/api/services/orgs/orgs-api-client.service.ts b/tests/github/api/services/orgs/orgs-api-client.service.ts
@@ -648,7 +648,7 @@ export class OrgsAPIClient implements OrgsAPIClientInterface {
     if ('xGitHubRequestId' in args) {
       options.headers = options.headers.set('X-GitHub-Request-Id', String(args.xGitHubRequestId));
     }
-    return this.http.put<void>(`${this.domain}${path}`, options);
+    return this.http.put<void>(`${this.domain}${path}`, null, options);
   }
 
   /**

diff --git a/tests/github/api/services/repos/repos-api-client.service.ts b/tests/github/api/services/repos/repos-api-client.service.ts
@@ -629,7 +629,7 @@ export class ReposAPIClient implements ReposAPIClientInterface {
     if ('xGitHubRequestId' in args) {
       options.headers = options.headers.set('X-GitHub-Request-Id', String(args.xGitHubRequestId));
     }
-    return this.http.put<void>(`${this.domain}${path}`, options);
+    return this.http.put<void>(`${this.domain}${path}`, null, options);
   }
 
   /**
@@ -1224,7 +1224,7 @@ export class ReposAPIClient implements ReposAPIClientInterface {
     if ('xGitHubRequestId' in args) {
       options.headers = options.headers.set('X-GitHub-Request-Id', String(args.xGitHubRequestId));
     }
-    return this.http.delete<models.DeleteFile>(`${this.domain}${path}`, JSON.stringify(args.body), options);
+    return this.http.delete<models.DeleteFile>(`${this.domain}${path}`, options);
   }
 
   /**
@@ -2939,7 +2939,7 @@ export class ReposAPIClient implements ReposAPIClientInterface {
     if ('xGitHubRequestId' in args) {
       options.headers = options.headers.set('X-GitHub-Request-Id', String(args.xGitHubRequestId));
     }
-    return this.http.post<void>(`${this.domain}${path}`, options);
+    return this.http.post<void>(`${this.domain}${path}`, null, options);
   }
 
   /**

diff --git a/tests/github/api/services/teams/teams-api-client.service.ts b/tests/github/api/services/teams/teams-api-client.service.ts
@@ -438,7 +438,7 @@ export class TeamsAPIClient implements TeamsAPIClientInterface {
     if ('xGitHubRequestId' in args) {
       options.headers = options.headers.set('X-GitHub-Request-Id', String(args.xGitHubRequestId));
     }
-    return this.http.put<void>(`${this.domain}${path}`, options);
+    return this.http.put<void>(`${this.domain}${path}`, null, options);
   }
 
   /**
@@ -606,7 +606,7 @@ export class TeamsAPIClient implements TeamsAPIClientInterface {
     if ('xGitHubRequestId' in args) {
       options.headers = options.headers.set('X-GitHub-Request-Id', String(args.xGitHubRequestId));
     }
-    return this.http.put<models.TeamMembership>(`${this.domain}${path}`, options);
+    return this.http.put<models.TeamMembership>(`${this.domain}${path}`, null, options);
   }
 
   /**
@@ -710,7 +710,7 @@ export class TeamsAPIClient implements TeamsAPIClientInterface {
     if ('xGitHubRequestId' in args) {
       options.headers = options.headers.set('X-GitHub-Request-Id', String(args.xGitHubRequestId));
     }
-    return this.http.put<void>(`${this.domain}${path}`, options);
+    return this.http.put<void>(`${this.domain}${path}`, null, options);
   }
 
   /**

diff --git a/tests/github/api/services/user/user-api-client.service.ts b/tests/github/api/services/user/user-api-client.service.ts
@@ -202,7 +202,7 @@ export class UserAPIClient implements UserAPIClientInterface {
     if ('xGitHubRequestId' in args) {
       options.headers = options.headers.set('X-GitHub-Request-Id', String(args.xGitHubRequestId));
     }
-    return this.http.delete<void>(`${this.domain}${path}`, JSON.stringify(args.body), options);
+    return this.http.delete<void>(`${this.domain}${path}`, options);
   }
 
   /**
@@ -580,7 +580,7 @@ export class UserAPIClient implements UserAPIClientInterface {
     if ('xGitHubRequestId' in args) {
       options.headers = options.headers.set('X-GitHub-Request-Id', String(args.xGitHubRequestId));
     }
-    return this.http.put<void>(`${this.domain}${path}`, options);
+    return this.http.put<void>(`${this.domain}${path}`, null, options);
   }
 
   /**
@@ -1242,7 +1242,7 @@ export class UserAPIClient implements UserAPIClientInterface {
     if ('xGitHubRequestId' in args) {
       options.headers = options.headers.set('X-GitHub-Request-Id', String(args.xGitHubRequestId));
     }
-    return this.http.put<void>(`${this.domain}${path}`, options);
+    return this.http.put<void>(`${this.domain}${path}`, null, options);
   }
 
   /**
@@ -1450,7 +1450,7 @@ export class UserAPIClient implements UserAPIClientInterface {
     if ('xGitHubRequestId' in args) {
       options.headers = options.headers.set('X-GitHub-Request-Id', String(args.xGitHubRequestId));
     }
-    return this.http.put<void>(`${this.domain}${path}`, options);
+    return this.http.put<void>(`${this.domain}${path}`, null, options);
   }
 
   /**