fix(cli): openapi generator implementation for controllers

This PR adds implementation to controllers

Signed-off-by: Muhammad Aaqil <aaqilniz@yahoo.com>

Author: aaqilniz

docs/site/OpenAPI-generator.md

@@ -31,8 +31,8 @@ lb4 openapi [<url>] [options]
 - `--validate`: Validate the OpenAPI spec. Default: `false`.
 - `--promote-anonymous-schemas`: Promote anonymous schemas as models classes.
   Default: `false`.
-- `--client`: Generate client-side service proxies for the OpenAPI spec Default:
-  `false`.
+- `--client`: Generate client-side service proxies and controllers with
+  implementation for the OpenAPI spec Default: `false`.
 - `--datasource`: A valid datasource name
 - `--positional`: A flag to control if service methods use positional parameters
   or an object with named properties. Default: `true`.
@@ -520,6 +520,98 @@ export class CustomerServiceProvider implements Provider<CustomerService> {
 }
 ````
 
+Along with service interface and proxy, controller implementation for each tag
+is generated by consuming the generated services.
+
+{% include code-caption.html content="src/services/customer.controller.ts"
+%}
+
+```
+import {operation, param} from '@loopback/rest';
+import {DateTime} from '../models/date-time.model';
+import {inject} from '@loopback/core';
+import {CustomerService} from '../services';'
+/**
+ * The controller class is generated from OpenAPI spec with operations tagged
+ * by account
+ *
+ */
+export class AccountController {
+  constructor(@inject('services.CustomerServic')
+  protected customerService: CustomerService) {}
+
+  /**
+   * Get list of carts.
+   */
+  @operation('get', '/account.cart.list.json')
+  async accountCartList(
+    @param({name: 'params', in: 'query'}) params: string,
+    @param({name: 'exclude', in: 'query'}) exclude: string,
+    @param({name: 'request_from_date', in: 'query'}) request_from_date: string,
+    @param({name: 'request_to_date', in: 'query'}) request_to_date: string,
+  ): Promise<{
+    result?: {
+      carts?: {
+        cart_id?: string;
+        id?: string;
+        store_key?: string;
+        total_calls?: string;
+        url?: string;
+      }[];
+      carts_count?: number;
+    };
+    return_code?: number;
+    return_message?: string;
+  }> {
+    return this.customerService.accountCartList(params, exclude, request_from_date, request_to_date);
+  }
+
+  /**
+   * Update configs in the API2Cart database.
+   */
+  @operation('put', '/account.config.update.json')
+  async accountConfigUpdate(
+    @param({name: 'db_tables_prefix', in: 'query'}) db_tables_prefix: string,
+    @param({name: 'client_id', in: 'query'}) client_id: string,
+    @param({name: 'bridge_url', in: 'query'}) bridge_url: string,
+    @param({name: 'store_root', in: 'query'}) store_root: string,
+    @param({name: 'shared_secret', in: 'query'}) shared_secret: string,
+  ): Promise<{
+    result?: {
+      updated_items?: number;
+    };
+    return_code?: number;
+    return_message?: string;
+  }> {
+    return this.customerService.accountConfigUpdate(db_tables_prefix, client_id, bridge_url, store_roo, shared_secret);
+  }
+
+  /**
+   * List webhooks that was not delivered to the callback.
+   */
+  @operation('get', '/account.failed_webhooks.json')
+  async accountFailedWebhooks(
+    @param({name: 'count', in: 'query'}) count: number,
+    @param({name: 'start', in: 'query'}) start: number,
+    @param({name: 'ids', in: 'query'}) ids: string,
+  ): Promise<{
+    result?: {
+      all_failed_webhook?: string;
+      webhook?: {
+        entity_id?: string;
+        time?: DateTime;
+        webhook_id?: number;
+      }[];
+    };
+    return_code?: number;
+    return_message?: string;
+  }> {
+	return this.customerService.accountFailedWebhooks(count, start, ids);
+  }
+}
+
+```
+
 ## OpenAPI Examples
 
 Try out the following specs or your own with `lb4 openapi`:

packages/cli/generators/openapi/index.js

@@ -292,12 +292,13 @@ module.exports = class OpenApiGenerator extends BaseGenerator {
     });
   }
 
-  _generateControllers() {
+  _generateControllers(withImplementation) {
     const source = this.templatePath(
       'src/controllers/controller-template.ts.ejs',
     );
     for (const c of this.selectedControllers) {
       const controllerFile = c.fileName;
+      c.withImplementation = withImplementation;
       if (debug.enabled) {
         debug(`Artifact output filename set to: ${controllerFile}`);
       }
@@ -478,7 +479,7 @@ module.exports = class OpenApiGenerator extends BaseGenerator {
     this._generateModels();
     await this._updateIndex(MODEL);
     if (this.options.server !== false) {
-      this._generateControllers();
+      this._generateControllers(this.options.client);
       await this._updateIndex(CONTROLLER);
     }
     if (this.options.client === true) {

packages/cli/generators/openapi/spec-helper.js

@@ -349,6 +349,24 @@ function buildMethodSpec(controllerSpec, op, options) {
   if (op.spec['x-implementation']) {
     methodSpec.implementation = op.spec['x-implementation'];
   }
+  if (!methodSpec.implementation) {
+    const methodParameters = {};
+    methodParameters[methodName] = [];
+    if (parameters) {
+      parameters.forEach(param => {
+        methodParameters[methodName].push(param.name);
+      });
+    }
+    if (op.spec.requestBody) {
+      methodParameters[methodName].push('_requestBody');
+    }
+    controllerSpec.serviceClassNameCamelCase = camelCase(
+      controllerSpec.serviceClassName,
+    );
+    methodSpec.implementation = `return this.${
+      controllerSpec.serviceClassNameCamelCase
+    }.${methodName}(${methodParameters[methodName].join(', ')});`;
+  }
   return methodSpec;
 
   /**

packages/cli/generators/openapi/templates/src/controllers/controller-template.ts.ejs

@@ -1,4 +1,8 @@
-import {api, operation, param, requestBody} from '@loopback/rest';
+import {api, operation, param, requestBody} from '@loopback/rest';<%if (withImplementation) { %>
+import {inject} from '@loopback/core';
+
+import {<%- serviceClassName %>} from '../services';
+  <% } %>
 <%_
 imports.forEach(i => {
 -%>
@@ -18,9 +22,11 @@ imports.forEach(i => {
 <%_ } -%>
  */
 <%- decoration %>
-export class <%- className %> {
-  constructor() {}
-
+export class <%- className %> {<% if(withImplementation){ %>
+    constructor(@inject('services.<%- serviceClassName %>')
+    protected <%- serviceClassNameCamelCase %>: <%- serviceClassName %>) {}
+  <% } else { %>
+    constructor() {} <% } %>
   <%_ for (const m of methods) { -%>
   /**
   <%_ for (const c of m.comments) {
@@ -35,9 +41,8 @@ export class <%- className %> {
    */
   <%- m.decoration %>
   <%- m.signature %> {
-    <%- m.implementation || "throw new Error('Not implemented');" %>
+    <% if(withImplementation){ %> <%- m.implementation %> <% } else{ %> throw new Error('Not implemented'); <% } %>
   }
-
   <%_ } -%>
 }
 

packages/cli/snapshots/integration/generators/openapi-client.integration.snapshots.js

@@ -431,6 +431,10 @@ export * from './open-api.controller';
 
 exports[`openapi-generator with --client allows baseModel option 2`] = `
 import {api, operation, param, requestBody} from '@loopback/rest';
+import {inject} from '@loopback/core';
+
+import {OpenApiService} from '../services';
+  
 import {Pet} from '../models/pet.model';
 import {NewPet} from '../models/new-pet.model';
 
@@ -493,8 +497,9 @@ import {NewPet} from '../models/new-pet.model';
   paths: {},
 })
 export class OpenApiController {
-  constructor() {}
-
+    constructor(@inject('services.OpenApiService')
+    protected openApiService: OpenApiService) {}
+  
   /**
    * Returns all pets from the system that the user has access to
 Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem
@@ -630,9 +635,8 @@ pulvinar elit eu, euismod sapien.
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
   [additionalProperty: string]: any;
 } | undefined): Promise<Pet[]> {
-    throw new Error('Not implemented');
+     return this.openApiService.findPets(tags, limit, where); 
   }
-
   /**
    * Creates a new pet in the store. Duplicates are allowed
    *
@@ -687,9 +691,8 @@ pulvinar elit eu, euismod sapien.
     },
   },
 }) _requestBody: NewPet): Promise<Pet> {
-    throw new Error('Not implemented');
+     return this.openApiService.addPet(_requestBody); 
   }
-
   /**
    * Returns a user based on a single ID, if the user does not have access to the
 pet
@@ -745,9 +748,8 @@ pet
     format: 'int64',
   },
 }) id: number): Promise<Pet> {
-    throw new Error('Not implemented');
+     return this.openApiService.findPetById(id); 
   }
-
   /**
    * deletes a single pet based on the ID supplied
    *
@@ -794,9 +796,8 @@ pet
     format: 'int64',
   },
 }) id: number): Promise<unknown> {
-    throw new Error('Not implemented');
+     return this.openApiService.deletePet(id); 
   }
-
 }
 
 
@@ -1136,8 +1137,7 @@ import {NewPet} from '../models/new-pet.model';
   paths: {},
 })
 export class OpenApiController {
-  constructor() {}
-
+    constructor() {} 
   /**
    * Returns all pets from the system that the user has access to
 Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem
@@ -1273,9 +1273,8 @@ pulvinar elit eu, euismod sapien.
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
   [additionalProperty: string]: any;
 } | undefined): Promise<Pet[]> {
-    throw new Error('Not implemented');
+     throw new Error('Not implemented'); 
   }
-
   /**
    * Creates a new pet in the store. Duplicates are allowed
    *
@@ -1330,9 +1329,8 @@ pulvinar elit eu, euismod sapien.
     },
   },
 }) _requestBody: NewPet): Promise<Pet> {
-    throw new Error('Not implemented');
+     throw new Error('Not implemented'); 
   }
-
   /**
    * Returns a user based on a single ID, if the user does not have access to the
 pet
@@ -1388,9 +1386,8 @@ pet
     format: 'int64',
   },
 }) id: number): Promise<Pet> {
-    throw new Error('Not implemented');
+     throw new Error('Not implemented'); 
   }
-
   /**
    * deletes a single pet based on the ID supplied
    *
@@ -1437,9 +1434,8 @@ pet
     format: 'int64',
   },
 }) id: number): Promise<unknown> {
-    throw new Error('Not implemented');
+     throw new Error('Not implemented'); 
   }
-
 }
 
 
@@ -1834,6 +1830,10 @@ export * from './open-api.controller';
 
 exports[`openapi-generator with --client generates all files for both server and client 2`] = `
 import {api, operation, param, requestBody} from '@loopback/rest';
+import {inject} from '@loopback/core';
+
+import {OpenApiService} from '../services';
+  
 import {Pet} from '../models/pet.model';
 import {NewPet} from '../models/new-pet.model';
 
@@ -1896,8 +1896,9 @@ import {NewPet} from '../models/new-pet.model';
   paths: {},
 })
 export class OpenApiController {
-  constructor() {}
-
+    constructor(@inject('services.OpenApiService')
+    protected openApiService: OpenApiService) {}
+  
   /**
    * Returns all pets from the system that the user has access to
 Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem
@@ -2033,9 +2034,8 @@ pulvinar elit eu, euismod sapien.
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
   [additionalProperty: string]: any;
 } | undefined): Promise<Pet[]> {
-    throw new Error('Not implemented');
+     return this.openApiService.findPets(tags, limit, where); 
   }
-
   /**
    * Creates a new pet in the store. Duplicates are allowed
    *
@@ -2090,9 +2090,8 @@ pulvinar elit eu, euismod sapien.
     },
   },
 }) _requestBody: NewPet): Promise<Pet> {
-    throw new Error('Not implemented');
+     return this.openApiService.addPet(_requestBody); 
   }
-
   /**
    * Returns a user based on a single ID, if the user does not have access to the
 pet
@@ -2148,9 +2147,8 @@ pet
     format: 'int64',
   },
 }) id: number): Promise<Pet> {
-    throw new Error('Not implemented');
+     return this.openApiService.findPetById(id); 
   }
-
   /**
    * deletes a single pet based on the ID supplied
    *
@@ -2197,9 +2195,8 @@ pet
     format: 'int64',
   },
 }) id: number): Promise<unknown> {
-    throw new Error('Not implemented');
+     return this.openApiService.deletePet(id); 
   }
-
 }