refactor: return response in json format (#2)

packages/functions/package.json

@@ -16,6 +16,7 @@
     "@middy/core": "^4.5.5",
     "@middy/http-error-handler": "^4.5.5",
     "@middy/http-json-body-parser": "^4.5.5",
+    "@middy/http-response-serializer": "^5.2.3",
     "@middy/util": "^5.2.3",
     "@middy/validator": "^4.5.5",
     "class-transformer": "^0.5.1",

packages/functions/src/shared/index.ts

@@ -0,0 +1,2 @@
+export * from './middleware';
+export * from './util';

packages/functions/src/shared/middleware/index.ts

@@ -0,0 +1,28 @@
+import middy from '@middy/core';
+import httpErrorHandler from '@middy/http-error-handler';
+import jsonBodyParser from '@middy/http-json-body-parser';
+import httpResponseSerializer from '@middy/http-response-serializer';
+
+export const middleware = () =>
+  middy()
+    .use(jsonBodyParser())
+    .use(httpErrorHandler())
+    .use(
+      httpResponseSerializer({
+        serializers: [
+          {
+            regex: /^application\/xml$/,
+            serializer: ({ body }) => `<message>${body}</message>`,
+          },
+          {
+            regex: /^application\/json$/,
+            serializer: ({ body }) => JSON.stringify(body),
+          },
+          {
+            regex: /^text\/plain$/,
+            serializer: ({ body }) => body,
+          },
+        ],
+        defaultContentType: 'application/json',
+      }),
+    );

packages/functions/src/shared/util/http.ts

@@ -0,0 +1,6 @@
+export interface HttpResponse {
+  statusCode: number;
+  body?: string | object;
+  headers?: { [key: string]: string };
+  error?: Error | string | object;
+}

packages/functions/src/shared/util/index.ts

@@ -0,0 +1 @@
+export * from './http';

packages/functions/src/student/studentDetails.ts

@@ -1,6 +1,6 @@
 import 'reflect-metadata';
-import { APIGatewayProxyEvent, APIGatewayProxyResult } from 'aws-lambda';
-import { middleware } from '../middleware';
+import { APIGatewayProxyEvent } from 'aws-lambda';
+import { middleware } from '../shared/middleware';
 import { plainToInstance } from 'class-transformer';
 import { IsString } from 'class-validator';
 import {
@@ -9,14 +9,15 @@ import {
 } from '@kma-score-serverless/core/index';
 import { UnexpectedError } from '@kma-score-serverless/core/shared';
 import { container } from '@kma-score-serverless/core/container';
+import { HttpResponse } from 'src/shared/util';
 
 class StudentPathParameters {
   @IsString()
   id!: string;
 }
 
 export const handler = middleware().handler(
-  async (event: APIGatewayProxyEvent): Promise<APIGatewayProxyResult> => {
+  async (event: APIGatewayProxyEvent): Promise<HttpResponse> => {
     const pathParameters = event.pathParameters as StudentPathParameters | null;
 
     const query = plainToInstance(StudentDetailsQuery, {
@@ -29,7 +30,7 @@ export const handler = middleware().handler(
     if (res.isOk) {
       return {
         statusCode: 200,
-        body: JSON.stringify(res.value),
+        body: res.value,
       };
     }