refactor: ♻️ renames the API modules folder from 'route' to 'api

Improve the semantic accuracy of the 'routes' folder by renaming it to 'api'.
edwinhern · Mar 7, 2024 · be43814 · be43814
1 parent 0f0eb76
commit be43814
Show file tree

Hide file tree

Showing 10 changed files with 15 additions and 15 deletions.
diff --git a/src/api-docs/openAPIDocumentGenerator.ts b/src/api-docs/openAPIDocumentGenerator.ts
@@ -1,7 +1,7 @@
 import { OpenApiGeneratorV3, OpenAPIRegistry } from '@asteasolutions/zod-to-openapi';
 
-import { healthCheckRegistry } from '@/routes/healthCheck/healthCheckRouter';
-import { userRegistry } from '@/routes/user/userRouter';
+import { healthCheckRegistry } from '@/api/healthCheck/healthCheckRouter';
+import { userRegistry } from '@/api/user/userRouter';
 
 export function generateOpenAPIDocument() {
   const registry = new OpenAPIRegistry([healthCheckRegistry, userRegistry]);

diff --git a/...Check/__tests__/healthCheckRouter.test.ts → ...Check/__tests__/healthCheckRouter.test.ts b/...Check/__tests__/healthCheckRouter.test.ts → ...Check/__tests__/healthCheckRouter.test.ts
diff --git a/src/routes/healthCheck/healthCheckRouter.ts → src/api/healthCheck/healthCheckRouter.ts b/src/routes/healthCheck/healthCheckRouter.ts → src/api/healthCheck/healthCheckRouter.ts
diff --git a/src/routes/user/__tests__/userRouter.test.ts → src/api/user/__tests__/userRouter.test.ts b/src/routes/user/__tests__/userRouter.test.ts → src/api/user/__tests__/userRouter.test.ts
@@ -1,9 +1,9 @@
 import { StatusCodes } from 'http-status-codes';
 import request from 'supertest';
 
+import { User } from '@/api/user/userModel';
+import { users } from '@/api/user/userRepository';
 import { ServiceResponse } from '@/common/models/serviceResponse';
-import { User } from '@/routes/user/userModel';
-import { users } from '@/routes/user/userRepository';
 import { app } from '@/server';
 
 describe('User API Endpoints', () => {

diff --git a/...routes/user/__tests__/userService.test.ts → src/api/user/__tests__/userService.test.ts b/...routes/user/__tests__/userService.test.ts → src/api/user/__tests__/userService.test.ts
@@ -1,11 +1,11 @@
 import { StatusCodes } from 'http-status-codes';
 import { Mock } from 'vitest';
 
-import { User } from '@/routes/user/userModel';
-import { userRepository } from '@/routes/user/userRepository';
-import { userService } from '@/routes/user/userService';
+import { User } from '@/api/user/userModel';
+import { userRepository } from '@/api/user/userRepository';
+import { userService } from '@/api/user/userService';
 
-vi.mock('@/routes/user/userRepository');
+vi.mock('@/api/user/userRepository');
 vi.mock('@/server', () => ({
   ...vi.importActual('@/server'),
   logger: {

diff --git a/src/routes/user/userModel.ts → src/api/user/userModel.ts b/src/routes/user/userModel.ts → src/api/user/userModel.ts
diff --git a/src/routes/user/userRepository.ts → src/api/user/userRepository.ts b/src/routes/user/userRepository.ts → src/api/user/userRepository.ts
@@ -1,4 +1,4 @@
-import { User } from '@/routes/user/userModel';
+import { User } from '@/api/user/userModel';
 
 export const users: User[] = [
   { id: 1, name: 'Alice', email: 'alice@example.com', age: 42, createdAt: new Date(), updatedAt: new Date() },

diff --git a/src/routes/user/userRouter.ts → src/api/user/userRouter.ts b/src/routes/user/userRouter.ts → src/api/user/userRouter.ts
@@ -2,10 +2,10 @@ import { OpenAPIRegistry } from '@asteasolutions/zod-to-openapi';
 import express, { Request, Response, Router } from 'express';
 import { z } from 'zod';
 
+import { GetUserSchema, UserSchema } from '@/api/user/userModel';
+import { userService } from '@/api/user/userService';
 import { createApiResponse } from '@/api-docs/openAPIResponseBuilders';
 import { handleServiceResponse, validateRequest } from '@/common/utils/httpHandlers';
-import { GetUserSchema, UserSchema } from '@/routes/user/userModel';
-import { userService } from '@/routes/user/userService';
 
 export const userRegistry = new OpenAPIRegistry();
 

diff --git a/src/routes/user/userService.ts → src/api/user/userService.ts b/src/routes/user/userService.ts → src/api/user/userService.ts
@@ -1,8 +1,8 @@
 import { StatusCodes } from 'http-status-codes';
 
+import { User } from '@/api/user/userModel';
+import { userRepository } from '@/api/user/userRepository';
 import { ResponseStatus, ServiceResponse } from '@/common/models/serviceResponse';
-import { User } from '@/routes/user/userModel';
-import { userRepository } from '@/routes/user/userRepository';
 import { logger } from '@/server';
 
 export const userService = {

diff --git a/src/server.ts b/src/server.ts
@@ -3,13 +3,13 @@ import express, { Express } from 'express';
 import helmet from 'helmet';
 import { pino } from 'pino';
 
+import { healthCheckRouter } from '@/api/healthCheck/healthCheckRouter';
+import { userRouter } from '@/api/user/userRouter';
 import { openAPIRouter } from '@/api-docs/openAPIRouter';
 import errorHandler from '@/common/middleware/errorHandler';
 import rateLimiter from '@/common/middleware/rateLimiter';
 import requestLogger from '@/common/middleware/requestLogger';
 import { env } from '@/common/utils/envConfig';
-import { healthCheckRouter } from '@/routes/healthCheck/healthCheckRouter';
-import { userRouter } from '@/routes/user/userRouter';
 
 const logger = pino({ name: 'server start' });
 const app: Express = express();