@gitanimals/api (#64)

* chore: exceptions to exception

* chore: CustomException 에러 타입 추가

* feature: api 패키지 생성

* feat: web에 내부 패키지 추가

* feat: instance

* feat: interceptor

* feat: getUser

* chore: lock

* chore: lock

* chore: directory name

* chore: zod to dev deps

apps/web/package.json

@@ -14,8 +14,9 @@
     "build-storybook": "storybook build"
   },
   "dependencies": {
+    "@gitanimals/api": "workspace:*",
     "@gitanimals/ui": "workspace:*",
-    "@gitanimals/exceptions": "workspace:*",
+    "@gitanimals/exception": "workspace:*",
     "@tanstack/react-query": "^5.32.0",
     "axios": "^1.6.8",
     "framer-motion": "^11.1.7",

packages/api/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@gitanimals/api",
+  "version": "0.0.0",
+  "main": "./src/index.ts",
+  "devDependencies": {
+    "@gitanimals/exception": "workspace:*",
+    "@gitanimals/eslint-config": "workspace:*",
+    "@gitanimals/typescript-config": "workspace:*",
+    "axios": "^1.6.8",
+    "typescript": "*",
+    "zod": "^3.23.8"
+  }
+}

packages/api/src/_instance/default.ts

@@ -0,0 +1,31 @@
+import axios from 'axios';
+import { setInterceptors } from '../_interceptor';
+
+const API_URL = 'https://api.gitanimals.org';
+
+const instance = setInterceptors(
+  axios.create({
+    baseURL: API_URL,
+    timeout: 15000,
+  }),
+);
+
+export const get = <T>(...args: Parameters<typeof instance.get>) => {
+  return instance.get<T, T>(...args);
+};
+
+export const post = <T>(...args: Parameters<typeof instance.post>) => {
+  return instance.post<T, T>(...args);
+};
+
+export const put = <T>(...args: Parameters<typeof instance.put>) => {
+  return instance.put<T, T>(...args);
+};
+
+export const patch = <T>(...args: Parameters<typeof instance.patch>) => {
+  return instance.patch<T, T>(...args);
+};
+
+export const del = <T>(...args: Parameters<typeof instance.delete>) => {
+  return instance.delete<T, T>(...args);
+};

packages/api/src/_instance/index.ts

@@ -0,0 +1,2 @@
+export * from './default';
+export * from './render';

packages/api/src/_instance/render.ts

@@ -0,0 +1,31 @@
+import axios from 'axios';
+import { setInterceptors } from '../_interceptor';
+
+const API_URL = 'https://render.gitanimals.org';
+
+const instance = setInterceptors(
+  axios.create({
+    baseURL: API_URL,
+    timeout: 15000,
+  }),
+);
+
+export const renderGet = <T>(...args: Parameters<typeof instance.get>) => {
+  return instance.get<T, T>(...args);
+};
+
+export const renderPost = <T>(...args: Parameters<typeof instance.post>) => {
+  return instance.post<T, T>(...args);
+};
+
+export const renderPut = <T>(...args: Parameters<typeof instance.put>) => {
+  return instance.put<T, T>(...args);
+};
+
+export const renderPatch = <T>(...args: Parameters<typeof instance.patch>) => {
+  return instance.patch<T, T>(...args);
+};
+
+export const renderDelete = <T>(...args: Parameters<typeof instance.delete>) => {
+  return instance.delete<T, T>(...args);
+};

packages/api/src/_interceptor/index.ts

@@ -0,0 +1,44 @@
+import type { AxiosError, AxiosInstance, AxiosResponse, InternalAxiosRequestConfig } from 'axios';
+
+import { ApiErrorScheme } from '../type';
+
+const interceptorRequestFulfilled = (config: InternalAxiosRequestConfig) => {
+  if (typeof window === 'undefined') return config;
+
+  // TODO: cookie 처리 시 변경 필요
+  // const accessToken = getToken();
+  if (!config.headers) return config;
+  // if (!accessToken) return config;
+
+  // config.headers.Authorization = `Bearer ${accessToken}`;
+
+  return config;
+};
+
+// Response interceptor
+const interceptorResponseFulfilled = (res: AxiosResponse) => {
+  if (200 <= res.status && res.status < 300) {
+    return res.data;
+  }
+
+  return Promise.reject(res.data);
+};
+
+// Response interceptor
+const interceptorResponseRejected = (error: AxiosError<ApiErrorScheme>) => {
+  if (error.response?.status === 401) {
+    // TODO : logout and refresh login
+    // TODO : logout 안내
+  }
+
+  // 403 처리
+
+  return Promise.reject(error);
+};
+
+export const setInterceptors = (instance: AxiosInstance) => {
+  instance.interceptors.request.use(interceptorRequestFulfilled);
+  instance.interceptors.response.use(interceptorResponseFulfilled, interceptorResponseRejected);
+
+  return instance;
+};

packages/api/src/index.ts

@@ -0,0 +1,3 @@
+export * from './_instance';
+export * from './type';
+export * from './user';

packages/api/src/type.ts

@@ -0,0 +1,3 @@
+export interface ApiErrorScheme {
+  message: string;
+}

packages/api/src/user/getUser.ts

@@ -0,0 +1,21 @@
+import { z } from 'zod';
+import { CustomException } from '@gitanimals/exception';
+import { get } from '../_instance';
+
+const UserSchema = z.object({
+  id: z.string(),
+  username: z.string(),
+  points: z.string(),
+  profileImage: z.string(),
+});
+
+type User = z.infer<typeof UserSchema>;
+
+export const getUser = async () => {
+  const res = await get<User>(`/users`);
+
+  const parsed = UserSchema.safeParse(res);
+  if (parsed.error) throw new CustomException('API_TYPE_NOT_MATCH');
+
+  return res;
+};

packages/api/src/user/index.ts

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

packages/exceptions/package.json → packages/exception/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@gitanimals/exceptions",
+  "name": "@gitanimals/exception",
   "version": "0.0.0",
   "main": "./src/index.ts",
   "devDependencies": {

packages/exceptions/src/CustomException.ts → packages/exception/src/CustomException.ts

@@ -1,9 +1,10 @@
-type CustomErrorCode = 'NETWORK_ERROR' | 'NETWORK_TIMEOUT' | 'UNKNOWN_ERROR';
+type CustomErrorCode = 'NETWORK_ERROR' | 'NETWORK_TIMEOUT' | 'UNKNOWN_ERROR' | 'API_TYPE_NOT_MATCH';
 
 const ERROR_MESSAGE: Record<CustomErrorCode, string> = {
-  NETWORK_ERROR: 'Network error',
-  NETWORK_TIMEOUT: 'Network timeout',
-  UNKNOWN_ERROR: 'Unknown error',
+  NETWORK_ERROR: '네트워크 에러',
+  NETWORK_TIMEOUT: '네트워크 타임아웃',
+  UNKNOWN_ERROR: '알 수 없는 에러',
+  API_TYPE_NOT_MATCH: 'API 응답 타입 불일치',
 };
 
 export class CustomException extends Error {

packages/exception/tsconfig.json

@@ -0,0 +1,5 @@
+{
+  "extends": "@gitanimals/typescript-config/base.json",
+  "include": ["src"],
+  "exclude": ["node_modules"]
+}