fixup! introduce ControllerSpec

loopbackio · Aug 1, 2017 · 6ea00e4 · 6ea00e4
1 parent 3af38f1
commit 6ea00e4
Show file tree

Hide file tree

Showing 11 changed files with 113 additions and 96 deletions.
diff --git a/packages/core/src/http-handler.ts b/packages/core/src/http-handler.ts
@@ -10,9 +10,9 @@ import {
   BoundValue,
   Constructor,
 } from '@loopback/context';
-import {OpenApiSpec, PathsObject} from '@loopback/openapi-spec';
+import {PathsObject} from '@loopback/openapi-spec';
 import {ServerRequest, ServerResponse} from 'http';
-import {getApiSpec} from './router/metadata';
+import {getApiSpec, ControllerSpec} from './router/metadata';
 
 import {SequenceHandler} from './sequence';
 import {
@@ -43,7 +43,7 @@ export class HttpHandler {
     this.handleRequest = (req, res) => this._handleRequest(req, res);
   }
 
-  registerController(name: ControllerClass, spec: OpenApiSpec) {
+  registerController(name: ControllerClass, spec: ControllerSpec) {
     this._routes.registerController(name, spec);
   }
 

diff --git a/packages/core/src/router/metadata.ts b/packages/core/src/router/metadata.ts
@@ -6,29 +6,43 @@
 import * as assert from 'assert';
 import {Reflector} from '@loopback/context';
 import {
-  OpenApiSpec,
   OperationObject,
   ParameterLocation,
   ParameterObject,
   SchemaObject,
   ParameterTypeValue,
   createEmptyApiSpec,
+  PathsObject,
 } from '@loopback/openapi-spec';
 
 const debug = require('debug')('loopback:core:router:metadata');
 
 // tslint:disable:no-any
 
+export interface ControllerSpec {
+  /**
+   * The base path on which the Controller API is served.
+   * If it is not included, the API is served directly under the host.
+   * The value MUST start with a leading slash (/).
+   */
+  basePath?: string;
+
+  /**
+   * The available paths and operations for the API.
+   */
+  paths: PathsObject;
+}
+
 /**
  * Decorate the given Controller constructor with metadata describing
  * the HTTP/REST API the Controller implements/provides.
  *
- * @param {OpenApiSpec} spec OpenAPI specification describing the endpoints
+ * @param spec OpenAPI specification describing the endpoints
  * handled by this controller
  *
  * @decorator
  */
-export function api(spec: OpenApiSpec) {
+export function api(spec: ControllerSpec) {
   return function(constructor: Function) {
     assert(
       typeof constructor === 'function',
@@ -43,10 +57,10 @@ interface RestEndpoint {
   path: string;
 }
 
-export function getApiSpec(constructor: Function): OpenApiSpec {
+export function getApiSpec(constructor: Function): ControllerSpec {
   debug(`Retrieving OpenAPI specification for controller ${constructor.name}`);
 
-  let spec: OpenApiSpec = Reflector.getMetadata(
+  let spec: ControllerSpec = Reflector.getMetadata(
     'loopback:api-spec',
     constructor,
   );
@@ -56,7 +70,7 @@ export function getApiSpec(constructor: Function): OpenApiSpec {
     return spec;
   }
 
-  spec = createEmptyApiSpec();
+  spec = {paths: {}};
   for (
     let proto = constructor.prototype;
     proto && proto !== Object.prototype;
@@ -67,7 +81,7 @@ export function getApiSpec(constructor: Function): OpenApiSpec {
   return spec;
 }
 
-function addPrototypeMethodsToSpec(spec: OpenApiSpec, proto: any) {
+function addPrototypeMethodsToSpec(spec: ControllerSpec, proto: any) {
   const controllerMethods = Object.getOwnPropertyNames(proto).filter(
     key => key !== 'constructor' && typeof proto[key] === 'function',
   );
@@ -77,7 +91,7 @@ function addPrototypeMethodsToSpec(spec: OpenApiSpec, proto: any) {
 }
 
 function addControllerMethodToSpec(
-  spec: OpenApiSpec,
+  spec: ControllerSpec,
   proto: any,
   methodName: string,
 ) {
@@ -182,7 +196,7 @@ export function patch(path: string, spec?: OperationObject) {
  *   of this operation.
  */
 export function del(path: string, spec?: OperationObject) {
-  return operation('del', path, spec);
+  return operation('delete', path, spec);
 }
 
 /**

diff --git a/packages/core/src/router/routing-table.ts b/packages/core/src/router/routing-table.ts
@@ -4,7 +4,6 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {
-  OpenApiSpec,
   OperationObject,
   ParameterObject,
   PathsObject,
@@ -20,6 +19,8 @@ import {
   OperationRetval,
 } from '../internal-types';
 
+import {ControllerSpec} from './metadata';
+
 import * as assert from 'assert';
 import * as url from 'url';
 const debug = require('debug')('loopback:core:routing-table');
@@ -54,7 +55,7 @@ export type ControllerClass = Constructor<any>;
 export class RoutingTable {
   private readonly _routes: RouteEntry[] = [];
 
-  registerController(controller: ControllerClass, spec: OpenApiSpec) {
+  registerController(controller: ControllerClass, spec: ControllerSpec) {
     assert(
       typeof spec === 'object' && !!spec,
       'API specification must be a non-null object',

diff --git a/packages/core/test/acceptance/routing/routing.acceptance.ts b/packages/core/test/acceptance/routing/routing.acceptance.ts
@@ -7,7 +7,6 @@ import {
   Application,
   api,
   get,
-  OpenApiSpec,
   ParameterObject,
   OperationObject,
   ServerRequest,

diff --git a/packages/core/test/acceptance/sequence/sequence.acceptance.ts b/packages/core/test/acceptance/sequence/sequence.acceptance.ts
@@ -6,7 +6,6 @@
 import {
   Application,
   api,
-  OpenApiSpec,
   ParameterObject,
   ServerRequest,
   ServerResponse,

diff --git a/packages/core/test/integration/application.integration.ts b/packages/core/test/integration/application.integration.ts
@@ -7,7 +7,6 @@ import {expect, createClientForApp} from '@loopback/testlab';
 import {
   Application,
   Route,
-  OpenApiSpec,
   ResponseObject,
   SchemaObject,
   ReferenceObject,

diff --git a/packages/core/test/integration/http-handler.integration.ts b/packages/core/test/integration/http-handler.integration.ts
@@ -9,10 +9,11 @@ import {
   ServerRequest,
   writeResultToResponse,
   RejectProvider,
+  ControllerSpec,
 } from '../..';
 import {Context} from '@loopback/context';
 import {expect, Client, createClientForHandler} from '@loopback/testlab';
-import {OpenApiSpec, ParameterObject} from '@loopback/openapi-spec';
+import {ParameterObject} from '@loopback/openapi-spec';
 import {anOpenApiSpec} from '@loopback/openapi-spec-builder';
 
 describe('HttpHandler', () => {
@@ -403,7 +404,7 @@ describe('HttpHandler', () => {
   function givenControllerClass(
     // tslint:disable-next-line:no-any
     ctor: new (...args: any[]) => Object,
-    spec: OpenApiSpec,
+    spec: ControllerSpec,
   ) {
     handler.registerController(ctor, spec);
   }

diff --git a/packages/core/test/unit/application/application.open-api-spec.test.ts b/packages/core/test/unit/application/application.open-api-spec.test.ts
@@ -4,7 +4,7 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {expect} from '@loopback/testlab';
-import {Application, api, OpenApiSpec, get, Route} from '../../..';
+import {Application, api, get, Route} from '../../..';
 import {anOpenApiSpec} from '@loopback/openapi-spec-builder';
 
 describe('Application.getApiSpec()', () => {

diff --git a/packages/core/test/unit/router/metadata.test.ts b/packages/core/test/unit/router/metadata.test.ts
@@ -47,14 +47,16 @@ describe('Routing metadata', () => {
 
     const actualSpec = getApiSpec(MyController);
 
-    const expectedSpec = anOpenApiSpec()
-      .withOperation(
-        'get',
-        '/greet',
-        Object.assign({'x-operation-name': 'greet'}, operationSpec),
-      )
-      .build();
-    expect(actualSpec).to.eql(expectedSpec);
+    expect(actualSpec).to.eql({
+      paths: {
+        '/greet': {
+          get: {
+            'x-operation-name': 'greet',
+            ...operationSpec,
+          },
+        },
+      },
+    });
   });
 
   it('returns spec defined via @post decorator', () => {
@@ -67,14 +69,16 @@ describe('Routing metadata', () => {
 
     const actualSpec = getApiSpec(MyController);
 
-    const expectedSpec = anOpenApiSpec()
-      .withOperation(
-        'post',
-        '/greeting',
-        Object.assign({'x-operation-name': 'createGreeting'}, operationSpec),
-      )
-      .build();
-    expect(actualSpec).to.eql(expectedSpec);
+    expect(actualSpec).to.eql({
+      paths: {
+        '/greeting': {
+          post: {
+            'x-operation-name': 'createGreeting',
+            ...operationSpec,
+          },
+        },
+      },
+    });
   });
 
   it('returns spec defined via @put decorator', () => {
@@ -87,14 +91,16 @@ describe('Routing metadata', () => {
 
     const actualSpec = getApiSpec(MyController);
 
-    const expectedSpec = anOpenApiSpec()
-      .withOperation(
-        'put',
-        '/greeting',
-        Object.assign({'x-operation-name': 'updateGreeting'}, operationSpec),
-      )
-      .build();
-    expect(actualSpec).to.eql(expectedSpec);
+    expect(actualSpec).to.eql({
+      paths: {
+        '/greeting': {
+          put: {
+            'x-operation-name': 'updateGreeting',
+            ...operationSpec,
+          },
+        },
+      },
+    });
   });
 
   it('returns spec defined via @patch decorator', () => {
@@ -107,14 +113,16 @@ describe('Routing metadata', () => {
 
     const actualSpec = getApiSpec(MyController);
 
-    const expectedSpec = anOpenApiSpec()
-      .withOperation(
-        'patch',
-        '/greeting',
-        Object.assign({'x-operation-name': 'patchGreeting'}, operationSpec),
-      )
-      .build();
-    expect(actualSpec).to.eql(expectedSpec);
+    expect(actualSpec).to.eql({
+      paths: {
+        '/greeting': {
+          patch: {
+            'x-operation-name': 'patchGreeting',
+            ...operationSpec,
+          },
+        },
+      },
+    });
   });
 
   it('returns spec defined via @del decorator', () => {
@@ -127,14 +135,16 @@ describe('Routing metadata', () => {
 
     const actualSpec = getApiSpec(MyController);
 
-    const expectedSpec = anOpenApiSpec()
-      .withOperation(
-        'del',
-        '/greeting',
-        Object.assign({'x-operation-name': 'deleteGreeting'}, operationSpec),
-      )
-      .build();
-    expect(actualSpec).to.eql(expectedSpec);
+    expect(actualSpec).to.eql({
+      paths: {
+        '/greeting': {
+          delete: {
+            'x-operation-name': 'deleteGreeting',
+            ...operationSpec,
+          },
+        },
+      },
+    });
   });
 
   it('returns spec defined via @operation decorator', () => {
@@ -147,14 +157,16 @@ describe('Routing metadata', () => {
 
     const actualSpec = getApiSpec(MyController);
 
-    const expectedSpec = anOpenApiSpec()
-      .withOperation(
-        'post',
-        '/greeting',
-        Object.assign({'x-operation-name': 'createGreeting'}, operationSpec),
-      )
-      .build();
-    expect(actualSpec).to.eql(expectedSpec);
+    expect(actualSpec).to.eql({
+      paths: {
+        '/greeting': {
+          post: {
+            'x-operation-name': 'createGreeting',
+            ...operationSpec,
+          },
+        },
+      },
+    });
   });
 
   it('returns default spec for @get with no spec', () => {
@@ -204,20 +216,22 @@ describe('Routing metadata', () => {
 
     const actualSpec = getApiSpec(Child);
 
-    const expectedSpec = anOpenApiSpec()
-      .withOperation(
-        'get',
-        '/parent',
-        Object.assign({'x-operation-name': 'getParentName'}, operationSpec),
-      )
-      .withOperation(
-        'get',
-        '/child',
-        Object.assign({'x-operation-name': 'getChildName'}, operationSpec),
-      )
-      .build();
-
-    expect(actualSpec).to.eql(expectedSpec);
+    expect(actualSpec).to.eql({
+      paths: {
+        '/parent': {
+          get: {
+            'x-operation-name': 'getParentName',
+            ...operationSpec,
+          },
+        },
+        '/child': {
+          get: {
+            'x-operation-name': 'getChildName',
+            ...operationSpec,
+          },
+        },
+      },
+    });
   });
 
   it('allows children to override parent REST endpoints', () => {