fix: add response object for ping

Signed-off-by: Raymond Feng <[email protected]>
loopbackio · Sep 24, 2018 · f1cc2bb · f1cc2bb
1 parent 74bfccb
commit f1cc2bb
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 3 deletions.
diff --git a/src/controllers/ping.controller.ts b/src/controllers/ping.controller.ts
@@ -7,14 +7,41 @@ import {Request, RestBindings} from '@loopback/rest';
 import {get} from '@loopback/openapi-v3';
 import {inject} from '@loopback/context';
 
+const PING_RESPONSE = {
+  description: 'Ping Response',
+  content: {
+    'application/json': {
+      schema: {
+        type: 'object',
+        properties: {
+          greeting: {type: 'string'},
+          date: {type: 'string'},
+          url: {type: 'string'},
+          headers: {
+            type: 'object',
+            patternProperties: {
+              '^.*$': {type: 'string'},
+            },
+            additionalProperties: false,
+          },
+        },
+      },
+    },
+  },
+};
+
 /**
  * A simple controller to bounce back http requests
  */
 export class PingController {
   constructor(@inject(RestBindings.Http.REQUEST) private req: Request) {}
 
   // Map to `GET /ping`
-  @get('/ping')
+  @get('/ping', {
+    responses: {
+      '200': PING_RESPONSE,
+    },
+  })
   ping(): object {
     return {
       greeting: 'Hello from LoopBack',

diff --git a/test/acceptance/ping.controller.acceptance.ts b/test/acceptance/ping.controller.acceptance.ts
@@ -3,7 +3,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {createClientForHandler, supertest} from '@loopback/testlab';
+import {createClientForHandler, supertest, expect} from '@loopback/testlab';
 import {RestServer} from '@loopback/rest';
 import {ShoppingApplication} from '../..';
 
@@ -30,7 +30,26 @@ describe('PingController', () => {
   });
 
   it('invokes GET /ping', async () => {
-    await client.get('/ping?msg=world').expect(200);
+    const res = await client.get('/ping?msg=world').expect(200);
+    expect(res.body).to.containEql({greeting: 'Hello from LoopBack'});
+  });
+
+  it('exposes OpenAPI spec at /openapi.json', async () => {
+    const res = await client.get('/openapi.json').expect(200);
+    expect(res.body).to.containDeep({
+      paths: {
+        '/ping': {
+          get: {
+            'x-controller-name': 'PingController',
+            'x-operation-name': 'ping',
+            tags: ['PingController'],
+            responses: {
+              '200': {description: 'Return value of PingController.ping'},
+            },
+          },
+        },
+      },
+    });
   });
 
   function givenAnApplication() {