Skip to content

API 명세

강성준 edited this page Nov 23, 2022 · 30 revisions

😀 User

  • [GET] 닉네임 조회(중복체크)
  • [GET] 회원가입 (Naver, Kakao, Google)
  • [GET] 로그인 (Naver, Kakao, Google)
    • SERVER_URL/user/login?social=${social} //social = ['naver','kakao','google']로 해당 페이지로 이동
    • Redirection 문제 때문에 axios 가 아닌 anchor 태그 사용 권장.
  • [GET] 로그아웃
    • SERVER_URL/user/logout 요청 시 AccessToken 만료.
    • 메인 페이지로 리다이렉트.
  • [DELETE] 회원탈퇴
    • SERVER_URL/user 로 요청 시 Guards 로 토큰 인증 확인.
    • 토큰이 인증되었다면, DB에서 해당 유저 제거.
    • 메인 페이지로 리다이렉트.

친구 기능

팔로우 목록 조회

  • API GET /friendship
  • 결과 (노출되는 자료들은 사용게 맞게 축소시킬 예정)
 [{ // 팔로잉 2명
     "id": "2526670883",
     "nickname": "hungjin",
     "characterName": "lion",
     "social": "kakao",
     "created_at": "2022-11-15",
     "deleted": false
 },
 {
     "id": "IZI_1Wzwhqblu0A4KA_TCrtkl4mM55Qstc_FDKMv_sY",
     "nickname": "hj",
     "characterName": "lion",
     "social": "naver",
     "created_at": "2022-11-15",
     "deleted": false
 }]
 []// 팔로잉 0명

닉네임으로 팔로우 신청

  • API PUT /friendship/{상대닉네임}
  • 성공 (200) "팔로우 성공"
  • 실패 (404)
    {
         "statusCode": 404,
         "message": "이미 팔로우한 유저입니다.",
         "error": "Not Found"
    }
    

닉네임으로 팔로우 취소

  • API DELETE /friendship/{상대닉네임}
  • 성공 (200) "팔로우 취소 성공"
  • 실패 (200) "팔로우 목록에 없는 유저"

🎮 Interface

  • [PATCH] 캐릭터 변경
  • [PATCH] 닉네임 변경
  • [GET] 친구 목록 조회
  • [DELETE] 친구 삭제

👨‍👩‍👧‍👦 공유

  • [GET] 기록 공유 전체 조회
  • [POST] 기록 공유 작성
  • [DELETE] 기록 공유 삭제
  • [POST] 좋아요 토글
Clone this wiki locally