[CHORE:#4] controller에 함수별 desc 추가 및 한글로 통일

Today-s-ramen · May 29, 2022 · efd5dfb · efd5dfb
1 parent 4f1afd4
commit efd5dfb
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 4 deletions.
diff --git a/src/controllers/ReviewController.ts b/src/controllers/ReviewController.ts
@@ -6,6 +6,11 @@ import statusCode from '../modules/statusCode';
 import util from '../modules/util';
 import { ReviewService } from '../services';
 
+/**
+ * @route GET /review
+ * @desc 리뷰 전체 데이터 조회
+ * @access Public
+ */
 const getReviewList = async (req: Request, res: Response): Promise<Response | void> => {
   try {
     const data = await ReviewService.getReviewList();
@@ -19,6 +24,12 @@ const getReviewList = async (req: Request, res: Response): Promise<Response | vo
   }
 };
 
+/**
+ * @route POST /review
+ * @param reviewId
+ * @desc 리뷰 등록
+ * @access Public
+ */
 const createReview = async (req: Request, res: Response): Promise<Response | void> => {
   const error = validationResult(req);
   if (!error.isEmpty()) {
@@ -42,6 +53,7 @@ const createReview = async (req: Request, res: Response): Promise<Response | voi
  * @route GET /review/:reviewId
  * @param reviewId
  * @desc 리뷰 상세페이지 조회
+ * @access Public
  */
 const findReviewById = async (req: Request, res: Response) => {
   const { reviewId } = req.params;

diff --git a/src/controllers/SubscribeController.ts b/src/controllers/SubscribeController.ts
@@ -8,8 +8,8 @@ import { SubscribeService } from '../services';
 
 /**
  * @route GET /subscribe
- * @desc read subscribe option
- * @access public
+ * @desc 라면 구독 옵션 정보 조회
+ * @access Public
  */
 const getSubscribeOptions = async (req: Request, res: Response) => {
   try {
@@ -26,8 +26,8 @@ const getSubscribeOptions = async (req: Request, res: Response) => {
 
 /**
  * @route POST /subscribe/
- * @desc create subscribe
- * @access public
+ * @desc 라면 구독 등록
+ * @access Public
  */
 const createSubscribe = async (req: Request, res: Response) => {
   const error = validationResult(req);