Merge pull request #58 from boostcampwm-2022/chore/#57-K

Chore/#57-K: API 파라미터 타입 정의

Author: se030

client/src/apis/auth.ts

@@ -1,3 +1,5 @@
+import { PostLoginParams } from 'params/auth';
+
 import { http } from './http';
 import { OK, CREATED } from './http-status';
 
@@ -9,7 +11,7 @@ export const getAuth = async () => {
   return res.data;
 };
 
-export const postAuthLogin = async (code: string) => {
+export const postAuthLogin = async ({ code }: PostLoginParams) => {
   const res = await http.post(`/auth/login`, { code });
 
   if (res.status !== CREATED) throw new Error();

client/src/apis/user.ts

@@ -1,8 +1,10 @@
+import { GetWorkspaceParams } from 'params/user';
+
 import { http } from './http';
 import { OK } from './http-status';
 
-export const getWorkspaces = async (userId: number) => {
-  const res = await http.get(`/user/${userId}/workspace`);
+export const getWorkspaces = async ({ id }: GetWorkspaceParams) => {
+  const res = await http.get(`/user/${id}/workspace`);
 
   if (res.status !== OK) throw new Error();
 

client/src/components/WorkspaceList/index.tsx

@@ -16,7 +16,7 @@ function WorkspaceList({ onSelectModalOpen }: WorkspaceListProps) {
   const userContext = useContext(UserContext);
 
   const updateWorkspaces = async (userId: number) => {
-    const { workspaces } = await getWorkspaces(userId);
+    const { workspaces } = await getWorkspaces({ id: userId });
     setWorkspaces(workspaces);
   };
 

client/src/pages/OAuth/index.tsx

@@ -18,7 +18,7 @@ function OAuthPage() {
 
   const login = async (code: string) => {
     try {
-      const authorizedUser = await postAuthLogin(code);
+      const authorizedUser = await postAuthLogin({ code });
 
       userContext.setUser(authorizedUser);
 

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/auth/service.ts

@@ -17,7 +17,7 @@ export const login = async (code: string) => {
     avatar_url: avatarUrl,
   } = await getGithubUser(accessToken, tokenType);
 
-  const isSignedUp = userModel.exists({ id });
+  const isSignedUp = await userModel.exists({ id });
 
   if (!isSignedUp) {
     await userModel.create({

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);
   }),
 );