feat(cli): improve openapi handling of body and impl

Author: raymondfeng

packages/cli/generators/openapi/index.js

@@ -108,6 +108,7 @@ module.exports = class OpenApiGenerator extends BaseGenerator {
     if (this.shouldExit()) return false;
     this._generateModels();
     this._generateControllers();
+    await this._updateIndex();
   }
 
   _generateControllers() {
@@ -145,9 +146,7 @@ module.exports = class OpenApiGenerator extends BaseGenerator {
     }
   }
 
-  async end() {
-    await super.end();
-    if (this.shouldExit()) return;
+  async _updateIndex() {
     const targetDir = this.destinationPath(`src/controllers`);
     for (const c of this.selectedControllers) {
       // Check all files being generated to ensure they succeeded
@@ -157,4 +156,9 @@ module.exports = class OpenApiGenerator extends BaseGenerator {
       }
     }
   }
+
+  async end() {
+    await super.end();
+    if (this.shouldExit()) return;
+  }
 };

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

@@ -5,19 +5,15 @@
 
 'use strict';
 const util = require('util');
-const json5 = require('json5');
 
 const {
   isExtension,
   titleCase,
   kebabCase,
   escapePropertyOrMethodName,
+  toJsonStr,
 } = require('./utils');
 
-function toJsonStr(val) {
-  return json5.stringify(val, null, 2);
-}
-
 function setImport(typeSpec) {
   if (typeSpec.fileName) {
     typeSpec.import = `import {${typeSpec.className}} from './${getBaseName(
@@ -165,10 +161,17 @@ function mapObjectType(schema, options) {
       );
       // The property name might have chars such as `-`
       const propName = escapePropertyOrMethodName(p);
+      let propDecoration = `@property({name: '${p}'})`;
+      if (propertyType.itemType && propertyType.itemType.kind === 'class') {
+        // Use `@property.array` for array types
+        propDecoration = `@property.array(${
+          propertyType.itemType.className
+        }, {name: '${p}'})`;
+      }
       const propSpec = {
         name: p,
         signature: `${propName + suffix}: ${propertyType.signature};`,
-        decoration: `@property({name: '${p}'})`,
+        decoration: propDecoration,
       };
       if (schema.properties[p].description) {
         propSpec.description = schema.properties[p].description;

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

@@ -17,6 +17,7 @@ const {
   camelCase,
   escapeIdentifier,
   escapePropertyOrMethodName,
+  toJsonStr,
 } = require('./utils');
 
 const HTTP_VERBS = [
@@ -150,9 +151,9 @@ function buildMethodSpec(controllerSpec, op, options) {
   const methodName = getMethodName(op.spec);
   let args = [];
   const parameters = op.spec.parameters;
+  // Keep track of param names to avoid duplicates
+  const paramNames = {};
   if (parameters) {
-    // Keep track of param names to avoid duplicates
-    const paramNames = {};
     args = parameters.map(p => {
       const name = escapeIdentifier(p.name);
       if (name in paramNames) {
@@ -167,7 +168,35 @@ function buildMethodSpec(controllerSpec, op, options) {
       }`;
     });
   }
-  let returnType = 'any';
+  if (op.spec.requestBody) {
+    /**
+     * requestBody:
+     *  description: Pet to add to the store
+     *  required: true
+     *  content:
+     *    application/json:
+     *      schema:
+     *        $ref: '#/components/schemas/NewPet'
+     */
+    let bodyType = {signature: 'any'};
+    const content = op.spec.requestBody.content;
+    const jsonType = content && content['application/json'];
+    if (jsonType && jsonType.schema) {
+      bodyType = mapSchemaType(jsonType.schema, options);
+      addImportsForType(bodyType);
+    }
+    let bodyName = 'body';
+    if (bodyName in paramNames) {
+      bodyName = `${bodyName}${paramNames[bodyName]++}`;
+    }
+    const bodyParam = bodyName; // + (op.spec.requestBody.required ? '' : '?');
+    // Add body as the 1st param
+    const bodySpec = ''; // toJsonStr(op.spec.requestBody);
+    args.unshift(
+      `@requestBody(${bodySpec}) ${bodyParam}: ${bodyType.signature}`,
+    );
+  }
+  let returnType = {signature: 'any'};
   const responses = op.spec.responses;
   if (responses) {
     /**
@@ -195,11 +224,15 @@ function buildMethodSpec(controllerSpec, op, options) {
   const signature = `async ${methodName}(${args.join(', ')}): Promise<${
     returnType.signature
   }>`;
-  return {
+  const methodSpec = {
     description: op.spec.description,
     decoration: `@operation('${op.verb}', '${op.path}')`,
     signature,
   };
+  if (op.spec['x-implementation']) {
+    methodSpec.implementation = op.spec['x-implementation'];
+  }
+  return methodSpec;
 
   function addImportsForType(typeSpec) {
     if (typeSpec.className && typeSpec.import) {

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

@@ -1,5 +1,5 @@
 /* tslint:disable:no-any */
-import {operation, param} from '@loopback/rest';
+import {operation, param, requestBody} from '@loopback/rest';
 <%_
 imports.forEach(i => {
 -%>
@@ -22,7 +22,7 @@ export class <%- className %> {
    */
   <%- m.decoration %>
   <%- m.signature %> {
-    throw new Error('Not implemented');
+    <%- m.implementation || "throw new Error('Not implemented');" %>
   }
 
   <%_ } -%>

packages/cli/generators/openapi/utils.js

@@ -7,6 +7,7 @@
 const fs = require('fs');
 const util = require('util');
 const _ = require('lodash');
+const json5 = require('json5');
 
 const utils = require('../../lib/utils');
 const debug = require('../../lib/debug')('openapi-generator');
@@ -168,6 +169,10 @@ function escapePropertyOrMethodName(name) {
   return name;
 }
 
+function toJsonStr(val) {
+  return json5.stringify(val, null, 2);
+}
+
 module.exports = {
   isExtension,
   titleCase,
@@ -177,4 +182,5 @@ module.exports = {
   camelCase: _.camelCase,
   escapeIdentifier,
   escapePropertyOrMethodName,
+  toJsonStr,
 };

packages/cli/smoke-test/openapi/code-gen-utils.js

@@ -57,8 +57,8 @@ function runNpmTest(sandbox) {
   return runNpmScript(sandbox, ['test']);
 }
 
-function runPrettier(sandbox) {
-  return runNpmScript(sandbox, ['run', 'prettier:fix']);
+function runLintFix(sandbox) {
+  return runNpmScript(sandbox, ['run', 'lint:fix']);
 }
 
 function runNpmScript(sandbox, args) {
@@ -95,5 +95,5 @@ module.exports = {
   generateOpenApiArtifacts,
   cleanSandbox,
   runNpmTest,
-  runPrettier,
+  runLintFix,
 };

packages/cli/smoke-test/openapi/real-world-apis.smoke.js

@@ -13,7 +13,7 @@ const {
   createAppProject,
   generateOpenApiArtifacts,
   cleanSandbox,
-  runPrettier,
+  runLintFix,
   runNpmTest,
 } = require('./code-gen-utils');
 
@@ -91,7 +91,7 @@ describe('Real-world APIs', () => {
       console.log('Sandbox app created: %s', sandbox);
       await generateOpenApiArtifacts(sandbox, api.swaggerUrl);
       console.log('OpenApi artifacts generated');
-      await runPrettier(sandbox);
+      await runLintFix(sandbox);
       console.log('Artifacts formatted with prettier');
       await runNpmTest(sandbox);
       console.log('npm test is passing', sandbox);

packages/cli/test/fixtures/openapi/3.0/customer.yaml

@@ -22,6 +22,7 @@ paths:
       tags:
         - Customer
       description: Returns all customers
+      operationId: getCustomers
       parameters:
         - name: if
           in: query
@@ -73,6 +74,7 @@ paths:
       tags:
         - Customer
       description: Returns a customer based on a single ID
+      x-implementation: "return {id: id, 'first-name': 'John', last-name: 'Smith'};"
       operationId: find customer by id
       parameters:
         - name: id
@@ -93,6 +95,17 @@ components:
   schemas:
     Name:
       type: string
+    Address:
+      type: object
+      properties:
+        street:
+          type: string
+        city:
+          type: string
+        state:
+          type: string
+        zipCode:
+          type: string
     Customer:
       required:
         - id
@@ -104,5 +117,9 @@ components:
           type: string
         last-name:
           $ref: '#/components/schemas/Name'
+        addresses:
+          type: array
+          items:
+            $ref: '#/components/schemas/Address'
 
 

packages/cli/test/unit/openapi/controller-spec.unit.js

@@ -26,8 +26,8 @@ describe('openapi to controllers/models', () => {
             description: 'Returns all customers',
             decoration: "@operation('get', '/customers')",
             signature:
-              "async ''(@param({name: 'if', in: 'query'}) _if: string[], " +
-              "@param({name: 'limit', in: 'query'}) limit: number, " +
+              "async getCustomers(@param({name: 'if', in: 'query'}) _if: " +
+              "string[], @param({name: 'limit', in: 'query'}) limit: number, " +
               "@param({name: 'access-token', in: 'query'}) " +
               'accessToken: string): ' +
               'Promise<Customer[]>',
@@ -36,12 +36,15 @@ describe('openapi to controllers/models', () => {
             description: 'Creates a new customer',
             decoration: "@operation('post', '/customers')",
             signature:
-              "async createCustomer(@param({name: 'access-token', " +
+              'async createCustomer(@requestBody() body: Customer, ' +
+              "@param({name: 'access-token', " +
               "in: 'query'}) accessToken: string): Promise<Customer>",
           },
           {
             description: 'Returns a customer based on a single ID',
             decoration: "@operation('get', '/customers/{id}')",
+            implementation:
+              "return {id: id, 'first-name': 'John', last-name: 'Smith'};",
             signature:
               "async findCustomerById(@param({name: 'id', in: 'path'}) " +
               'id: number): Promise<Customer>',

packages/cli/test/unit/openapi/schema-model.unit.js

@@ -179,6 +179,41 @@ describe('schema to model', () => {
         declaration: 'string',
         signature: 'Name',
       },
+      {
+        description: 'Address',
+        name: 'Address',
+        className: 'Address',
+        fileName: 'address.model.ts',
+        properties: [
+          {
+            name: 'street',
+            signature: 'street?: string;',
+            decoration: "@property({name: 'street'})",
+          },
+          {
+            name: 'city',
+            signature: 'city?: string;',
+            decoration: "@property({name: 'city'})",
+          },
+          {
+            name: 'state',
+            signature: 'state?: string;',
+            decoration: "@property({name: 'state'})",
+          },
+          {
+            name: 'zipCode',
+            signature: 'zipCode?: string;',
+            decoration: "@property({name: 'zipCode'})",
+          },
+        ],
+        imports: [],
+        import: "import {Address} from './address.model';",
+        kind: 'class',
+        declaration:
+          '{\n  street?: string;\n  city?: string;\n  state?: string;\n' +
+          '  zipCode?: string;\n}',
+        signature: 'Address',
+      },
       {
         description: 'Customer',
         name: 'Customer',
@@ -200,12 +235,21 @@ describe('schema to model', () => {
             signature: "'last-name'?: Name;",
             decoration: "@property({name: 'last-name'})",
           },
+          {
+            name: 'addresses',
+            signature: 'addresses?: Address[];',
+            decoration: "@property.array(Address, {name: 'addresses'})",
+          },
+        ],
+        imports: [
+          "import {Name} from './name.model';",
+          "import {Address} from './address.model';",
         ],
-        imports: ["import {Name} from './name.model';"],
         import: "import {Customer} from './customer.model';",
         kind: 'class',
         declaration:
-          "{\n  id: number;\n  'first-name'?: string;\n  'last-name'?: Name;\n}",
+          "{\n  id: number;\n  'first-name'?: string;\n  " +
+          "'last-name'?: Name;\n  addresses?: Address[];\n}",
         signature: 'Customer',
       },
     ]);