Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

♻️ refactor: FeedController, FeedService 리팩토링 #257

Merged
merged 6 commits into from
Dec 3, 2024
Merged

♻️ refactor: FeedController, FeedService 리팩토링 #257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e7ad843
♻️ refactor: feedController, FeedService 메서드 네이밍 컨벤션에 따라 수정
CodeVac513 Dec 2, 2024
3e7a91e
📝 docs: swagger 메서드별로 파일 나누고 네이밍 컨벤션에 따라 데코레이터 수정
CodeVac513 Dec 2, 2024
fe03e1f
Merge branch 'main' into refactor/feed-structure
CodeVac513 Dec 2, 2024
79da3a9
♻️ refactor: service 계층에 있던 DB 접근 관련 로직을 Repository 계층으로 분리
CodeVac513 Dec 2, 2024
d137f5d
♻️ refactor: badRequest 예외처리를 Service에서 할 수 있도록 수정
CodeVac513 Dec 3, 2024
0354b67
♻️ refactor: repository 메서드 롤백 및 switch case문 수정
CodeVac513 Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 88 additions & 0 deletions server/src/feed/api-docs/readFeedList.api-docs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
import { applyDecorators } from '@nestjs/common';
import {
ApiBadRequestResponse,
ApiOkResponse,
ApiOperation,
ApiQuery,
} from '@nestjs/swagger';

export function ApiReadFeedList() {
return applyDecorators(
ApiOperation({
summary: `메인 화면 게시글 조회 API`,
}),
ApiQuery({
name: 'lastId',
required: false,
type: Number,
description: '마지막으로 받은 피드의 ID',
example: 10,
}),
ApiQuery({
name: 'limit',
required: false,
type: Number,
description: '한 번에 가져올 피드 수',
example: 5,
default: 12,
}),
ApiOkResponse({
description: 'Ok',
schema: {
properties: {
message: {
type: 'string',
},
data: {
type: 'object',
properties: {
result: {
type: 'array',
items: {
type: 'object',
properties: {
id: { type: 'number' },
author: { type: 'string' },
blogPlatform: { type: 'string' },
title: { type: 'string' },
path: { type: 'string', format: 'url' },
createAt: { type: 'string', format: 'date-time' },
thumbnail: { type: 'string', format: 'url' },
viewCount: { type: 'number' },
},
},
},
lastId: { type: 'number' },
hasMore: { type: 'boolean' },
},
},
},
},
example: {
message: '피드 조회 완료',
data: {
result: [
{
id: 3,
author: '블로그 이름',
blogPlatform: '블로그 서비스 플랫폼',
title: '피드 제목',
path: 'https://test.com',
createAt: '2024-06-16T20:00:57.000Z',
thumbnail: 'https://test.com/image.png',
viewCount: 1,
},
],
lastId: 3,
hasMore: true,
},
},
}),
ApiBadRequestResponse({
description: 'Bad Request',
example: {
message: '오류 메세지',
},
}),
);
}
54 changes: 54 additions & 0 deletions server/src/feed/api-docs/readRecentFeedList.api-docs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
import { applyDecorators } from '@nestjs/common';
import { ApiOkResponse, ApiOperation } from '@nestjs/swagger';

export function ApiReadRecentFeedList() {
return applyDecorators(
ApiOperation({
summary: '최신 피드 업데이트 API',
}),
ApiOkResponse({
description: 'Ok',
schema: {
properties: {
message: {
type: 'string',
},
data: {
type: 'array',
items: {
type: 'object',
properties: {
id: { type: 'number' },
author: { type: 'string' },
blogPlatform: { type: 'string' },
title: { type: 'string' },
path: { type: 'string' },
createdAt: {
type: 'string',
format: 'date-time',
},
thumbnail: { type: 'string' },
viewCount: { type: 'number' },
},
},
},
},
},
example: {
message: '최신 피드 업데이트 완료',
data: [
{
id: 1,
author: '블로그 이름',
blogPlatform: 'etc',
title: '게시글 제목',
path: 'https://test1.com/1',
createdAt: '2024-11-24T01:00:00.000Z',
thumbnail: 'https://test1.com/test.png',
viewCount: 0,
},
],
},
}),
);
}
97 changes: 97 additions & 0 deletions server/src/feed/api-docs/readTrendFeedList.api-docs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
import { applyDecorators } from '@nestjs/common';
import { ApiOkResponse, ApiOperation } from '@nestjs/swagger';

export function ApiReadTrendFeedList() {
return applyDecorators(
ApiOperation({
summary: '트렌드 게시글 조회 SSE',
}),
ApiOkResponse({
description: 'Ok',
schema: {
properties: {
message: {
type: 'string',
},
data: {
type: 'array',
items: {
type: 'object',
properties: {
id: { type: 'number' },
author: { type: 'string' },
blogPlatform: { type: 'string' },
title: { type: 'string' },
path: { type: 'string' },
createdAt: {
type: 'string',
format: 'date-time',
},
thumbnail: { type: 'string' },
viewCount: { type: 'number' },
},
},
},
},
},
examples: {
connect: {
summary: '현재 트렌드 피드 수신 완료',
value: {
message: '현재 트렌드 피드 수신 완료',
data: [
{
id: 1,
author: '블로그 이름',
blogPlatform: '블로그 서비스 플랫폼',
title: '피드 제목',
path: 'https://test1.com/1',
createdAt: '2024-11-24T01:00:00.000Z',
thumbnail: 'https://test1.com/test.png',
viewCount: 0,
},
{
id: 2,
author: '블로그 이름',
blogPlatform: '블로그 서비스 플랫폼',
title: '피드 제목',
path: 'https://test2.com/1',
createdAt: '2024-11-24T02:00:00.000Z',
thumbnail: 'https://test2.com/test.png',
viewCount: 0,
},
],
},
},
continue: {
summary: '새로운 트렌드 피드 수신 완료',
value: {
message: '새로운 트렌드 피드 수신 완료',
data: [
{
id: 3,
author: '블로그 이름',
blogPlatform: '블로그 서비스 플랫폼',
title: '피드 제목',
path: 'https://test3.com/1',
createdAt: '2024-11-24T03:00:00.000Z',
thumbnail: 'https://test3.com/test.png',
viewCount: 0,
},
{
id: 4,
author: '블로그 이름',
blogPlatform: '블로그 서비스 플랫폼',
title: '피드 제목',
path: 'https://test4.com/1',
createdAt: '2024-11-24T04:00:00.000Z',
thumbnail: 'https://test4.com/test.png',
viewCount: 0,
},
],
},
},
},
}),
);
}
116 changes: 116 additions & 0 deletions server/src/feed/api-docs/searchFeedList.api-docs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
import { applyDecorators } from '@nestjs/common';
import {
ApiBadRequestResponse,
ApiOkResponse,
ApiOperation,
ApiQuery,
} from '@nestjs/swagger';
import { SearchType } from '../dto/search-feed.dto';

export function ApiSearchFeedList() {
return applyDecorators(
ApiOperation({
summary: `검색 API`,
}),
ApiQuery({
name: 'find',
required: true,
type: String,
description: '검색어',
example: '데나무',
}),
ApiQuery({
name: 'type',
required: true,
enum: SearchType,
description: '검색 타입',
example: SearchType.ALL,
}),
ApiQuery({
name: 'page',
required: true,
type: Number,
description: '페이지 번호',
example: 1,
}),
ApiQuery({
name: 'limit',
required: true,
type: Number,
description: '한 페이지에 보여줄 개수',
example: 4,
}),
ApiOkResponse({
description: 'Ok',
schema: {
properties: {
message: {
type: 'string',
},
data: {
type: 'object',
properties: {
totalCount: {
type: 'number',
},
result: {
type: 'array',
items: {
type: 'object',
properties: {
id: {
type: 'number',
},
blogName: {
type: 'string',
},
title: {
type: 'string',
},
path: {
type: 'string',
format: 'url',
},
createdAt: {
type: 'string',
format: 'date-time',
},
},
},
},
totalPages: {
type: 'number',
},
limit: {
type: 'number',
},
},
},
},
},
example: {
message: '검색 결과 조회 완료',
data: {
totalCount: 1,
result: [
{
id: 1,
blogName: '블로그 이름',
title: '데나무',
path: 'https://test.com/1',
createdAt: '2024-10-27T02:08:55.000Z',
},
],
totalPages: 3,
limit: 1,
},
},
}),
ApiBadRequestResponse({
description: 'Bad Request',
example: {
message: '오류 메세지',
},
}),
);
}
Loading
Loading