/TS-backend-SNS

Express, TypeScript로 구현한 SNS 백엔드 서비스

Primary LanguageTypeScript

Express, TypeScript로 구현한 SNS 백엔드 서비스


Project

서비스 개요

  • 사용자는 본 서비스에 접속하여 게시물을 업로드하거나 다른 사람의 게시물을 확인하고, 좋아요를 누를 수 있습니다.

개발 기간

  • 1차 개발(필수기능 구현): 2022/07/20 ~ 2022/07/26
  • 2차 개발(서비스 고도화 및 리팩토링): 2022/07/27 ~ 2022/07/29

요구사항

1. 유저 관리

  • 유저 회원가입: 이메일을 ID로 사용
  • 유저 로그인 및 인증: JWT토큰을 발급받으며, 이를 추후 사용자 인증으로 사용
    • 로그아웃은 프론트엔드에서 처리

2. 게시글

  • 게시글 생성: 제목, 해시태그 등을 입력하여 생성
    • 제목, 내용, 해시태그는 필수 입력사항이며, 작성자 정보는 request body에 존재하지 않고, 해당 API를 요청한 인증정보에서 추출하여 등록
    • 해시태그는 #로 시작되고 ,로 구분되는 텍스트가 입력
  • 게시글 수정: 작성자만 수정 가능
  • 게시글 삭제: 작성자만 삭제 가능
    • 삭제된 게시글은 작성자에 의해 다시 복구 가능
  • 게시글 상세보기: 모든 사용자는 모든 게시물에 보기권한 있음
    • 작성자를 포함한 사용자는 본 게시글에 좋아요 누르기 가능(다시 좋아요 누를 시, 좋아요 취소)
    • 작성자 포함한 사용자가 게시글 상세보기 하면 조회수 1 증가(횟수제한 없음)
  • 게시글 목록: 모든 사용자는 모든 게시물에 보기권한 있음
    • 게시글 목록에는 제목, 작성자, 해시태그, 작성일, 좋아요 수, 조회수 포함

게시글 목록 조회 시 , 아래 4가지 동작 구현(동시에 적용 가능)

  • Ordering (=sorting, 정렬)
    • 사용자는 게시글 목록을 원하는 값으로 정렬 가능
      • default: 작성일
      • 작성일, 좋아요 수, 조회수 중 1개만 선택 가능
    • 오름차순, 내림차순 선택 가능
  • Searching (=검색)
    • 사용자는 입력한 키워드로 해당 키워드를 포함한 게시물 조회 가능
  • Filtering (= 필터링)
    • 사용자는 지정한 키워드로 해당 해시태그를 포함한 게시물 필터링 가능
  • Pagination (= 페이지 기능)
    • 사용자는 1페이지 당 게시글 수 조정 가능
      • default: 10건

DB 모델링

  • ERD

image


API 설계

유저 회원가입

  • URL: base-url/users/join

  • METHOD: POST

  • Request

     {
   userId: "goodday@gamil.com",
   password: "123qweasd!",
   name: "찰리푸스"
 }

  • Response

    • status: 201

      {
  messege: "회원가입이 완료되었습니다."
}

유저 로그인

  • URL: base-url/users/login

  • METHOD: POST

  • Request

     {
   userId: "goodday@gamil.com",
   password: "123qweasd!"
 }

  • Response

    • status: 200
     {
   messege: "로그인되었습니다."
   accessToken: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJp..."
 }

게시글 생성

  • URL: base-url/posts

  • METHOD: POST

  • Request

     {
   title: "브런치 카페 존맛",
   content: "꿀꿀꿀꿀",
   hashtags: "#맛집,#서울,#브런치 카페,#주말"
 }

  • Response

    • status: 200
     {
   messege: "포스팅되었습니다."
 }

게시글 수정

  • URL: base-url/posts/:postId

  • METHOD: PATCH

  • Request

     {
   title: "브런치 카페 존맛",
   content: "낄낄낄낄",
   hashtags: "#맛집,#서울,#브런치 카페,#주말"
 }

  • Response

    • status: 200
     {
   messege: "해당 게시글을 수정했습니다."
 }

게시글 삭제

  • URL: base-url/posts/:postId

  • METHOD: PATCH

  • Request

     {
   state: false
 }

  • Response

    • status: 200
     {
   messege: "해당 게시글을 삭제했습니다."
 }

삭제 게시글 복구

  • URL: base-url/posts/:postId

  • METHOD: PATCH

  • Request

     {
   state: true
 }

  • Response

    • status: 200
     {
   messege: "해당 게시글을 복구했습니다."
 }

게시글 상세보기

  • URL: base-url/posts/:postId

  • METHOD: GET

  • Request

  • Response

    • status: 200
     {
   title: "브런치 카페 존맛",
   content: "낄낄낄낄",
   hashtags: "#맛집,#서울,#브런치 카페,#주말",
   views: 7,
   likes: 1
 }

게시글 좋아요, 좋아요 취소

  • URL: base-url/posts/likes/:postId

  • METHOD: PATCH

  • Request

  • Response

    • status: 200
     // 좋아요 누를  시
 {
   messege: "이 글을 좋아합니다!"
 }

 // 좋아요 취소 시
 {
   messege: "좋아요를 취소합니다!"
 }

게시글 목록 조회

  • URL: base-url/posts

  • METHOD: GET

  • Request

  • Response

    • status: 200
     [
   {
 	title: "브런치 카페 존맛",
 	writer: "찰리푸스",
 	hashtags: "#맛집,#서울,#브런치 카페,#주말",
 	createdAt: "2022-07-22 12:14",
 	views: 7,
 	likes: 1
   },
   {
 	title: "힐링힐링",
 	writer: "전정국",
 	hashtags: "#힐링,#주말,#날씨,#쾌적",
 	createdAt: "2022-07-24 13:05",
 	views: 7,
 	likes: 1
   },
   ...
 ]

필수 기능 구현

유저 인증 기능 JWT 방식 구현

  • 로그인 시 유효한 사용자라면 사용자에게 access token 전달하고, refresh token은 DB refreshToken 테이블에 저장
    • access token 유효 기간: 15분
    • refresh token 유효 기간: 60일
    • access token 만료 시, refresh token을 기반으로 재발급
  • 사용자 인증이 필요한 api에 접근할 때, authenticateToken() 미들웨어를 통해 JWT 유효성 검증 실시
    • 클라이언트에서는 api를 요청할 때마다 request headers에 "Authorization" : " Bearer eyJhbGciOi..." 를 담아서 요청한다.

게시글 관련 로직 구현

API 설계 참조


부가 기능 구현

게시글 목록 4가지 기능 동작

게시글 목록 조회는 정렬, 검색, 필터링, 페이지기능이 동시에 적용 가능해야 한다.

정렬

  • query parameter: url?orderBy=
  • 파라미터 값이 ascending 이면 오름차순 정렬
  • 파라미터 값이 descending 이면 내림차순 정렬

검색

  • query parameter: url?search=
  • title(제목)에 파라미터 값의 키워드를 포함한 게시글 조회

페이지 기능

  • query parameter: url?pages=
  • 10, 30, 50 의 값 선택할 수 있도록 설정

필터링

  • query parameter: url?hashtags=
  • 해당 키워드를 포함한 해시태그를 가진 게시글 조회

추가 구현

redis 활용

docker 작업