chore: API 파라미터 타입 정의

Author: se030

client/tsconfig.json

@@ -5,7 +5,8 @@
       "src/*": ["./src/*"],
       "components/*": ["./src/components/*"],
       "config": ["./src/config"],
-      "styles/*": ["./src/styles/*"]
+      "styles/*": ["./src/styles/*"],
+      "params/*": ["../types/params/*"]
     },
     "target": "ESNext",
     "useDefineForClassFields": true,

client/vite.config.ts

@@ -15,6 +15,7 @@ export default defineConfig({
       },
       { find: 'config', replacement: resolve(__dirname, './src/config') },
       { find: 'styles', replacement: resolve(__dirname, './src/styles') },
+      { find: 'params', replacement: resolve(__dirname, '../types/params') },
     ],
   },
 });

server/apis/auth/controller.ts

@@ -3,6 +3,7 @@ import asyncWrapper from '@utils/async-wrapper';
 import jwtAuthenticator from '@middlewares/jwt-authenticator';
 import * as authService from './service';
 import { OK, CREATED } from '@constants/http-status';
+import { postLoginParams } from '@params/auth';
 
 interface CookieOptions {
   httpOnly: boolean;
@@ -23,7 +24,7 @@ router.get(
 
 router.post(
   '/login',
-  asyncWrapper(async (req: Request, res: Response) => {
+  asyncWrapper(async (req: Request<postLoginParams>, res: Response) => {
     const { code } = req.body;
 
     const { user, loginToken, refreshToken } = await authService.login(code);

server/apis/user/controller.ts

@@ -2,13 +2,14 @@ import express, { Request, Response } from 'express';
 import asyncWrapper from '@utils/async-wrapper';
 import * as userService from './service';
 import jwtAuthenticator from '@middlewares/jwt-authenticator';
+import { getWorkspaceParams } from '@params/user';
 
 const router = express.Router();
 
 router.get(
   '/:id/workspace',
   jwtAuthenticator,
-  asyncWrapper(async (req: Request, res: Response) => {
+  asyncWrapper(async (req: Request<getWorkspaceParams>, res: Response) => {
     const { id: userId } = req.user;
     const { id: targetUserId } = req.params;
 

server/apis/workspace/controller.ts

@@ -2,30 +2,31 @@ import express, { Request, Response } from 'express';
 import asyncWrapper from '@utils/async-wrapper';
 import jwtAuthenticator from '@middlewares/jwt-authenticator';
 import * as workspaceService from './service';
-import { OK } from '@constants/http-status';
+import { CREATED } from '@constants/http-status';
+import { postParams, postJoinParams } from '@params/workspace';
 
 const router = express.Router();
 
 router.post(
   '/',
-  asyncWrapper(async (req: Request, res: Response) => {
+  asyncWrapper(async (req: Request<postParams>, res: Response) => {
     const { name } = req.body;
 
     const workspace = await workspaceService.create(name);
 
-    res.status(OK).send({ ...workspace });
+    res.status(CREATED).send({ ...workspace });
   }),
 );
 
 router.post(
   '/join',
   jwtAuthenticator,
-  asyncWrapper(async (req: Request, res: Response) => {
+  asyncWrapper(async (req: Request<postJoinParams>, res: Response) => {
     const { code } = req.body;
 
     const joinedWorkspace = await workspaceService.join(req.user.id, code);
 
-    res.status(OK).send(joinedWorkspace);
+    res.status(CREATED).send(joinedWorkspace);
   }),
 );
 

server/tsconfig.json

@@ -19,7 +19,6 @@
     "esModuleInterop": true,
     "downlevelIteration": true,
     "typeRoots": ["../node_modules/@types", "./@types"],
-    "rootDir": ".",
     "outDir": "./dist",
     "plugins": [
       {

server/tsconfig.path.json

@@ -8,7 +8,8 @@
       "@errors/*": ["errors/*"],
       "@db": ["db"],
       "@middlewares/*": ["middlewares/*"],
-      "@utils/*": ["utils/*"]
+      "@utils/*": ["utils/*"],
+      "@params/*": ["../types/params/*"]
     }
   }
 }

types/params/auth.ts

@@ -0,0 +1,3 @@
+export interface postLoginParams {
+  code: string;
+}

types/params/user.ts

@@ -0,0 +1,3 @@
+export interface getWorkspaceParams {
+  id: number;
+}

types/params/workspace.ts

@@ -0,0 +1,7 @@
+export interface postParams {
+  name: string;
+}
+
+export interface postJoinParams {
+  code: string;
+}