API 안내
API Host는
https://kdt.frontend.5th.programmers.co.kr 입니다.API 사용에 문제가 있다면 문의바랍니다.
- 주의할 점으로 API에 예외 처리가 안되어있는 경우가 있습니다. 이 경우 프론트엔드에서 Form Validation을 해주시면 됩니다.
- 응답이 모델로 되어있는 경우 하단 모델 안내를 확인해주세요.
- Optional으로 적혀있는 경우 값을 넣지 않아도 동작하는 필드입니다.
- Nullable으로 적혀있는 경우 null이 내려올 수 있는 필드입니다.
- []는 리스트 타입입니다.
- API URL에 중괄호로 감싸져 있는 부분은 Path Variable 입니다.
API에 추가적인 데이터가 필요한 경우
해당 서버는 많은 팀이 사용 중이기 때문에 각각 커스터마이징을 해드릴 수는 없습니다. 대신 API 서버의 데이터베이스로 MongoDB를 사용하고 있고 대부분의 필드는 String으로 구성이 되어있기 때문에 필드에 사용자 정의 JSON 값을 넣어서 처리하는 방법을 사용할 수 있습니다.
예를 들어, Post 모델에 제목과 내용을 분리하고 싶다면
title 필드에 사용자 정의 JSON을 String으로 변환하여 넣을 수 있습니다. 이를 간단한 의사 코드로 표현하자면 다음과 같습니다.const json = { "title": "제목", "body": "내용" }; API.createPost(JSON.stringify(json), ...);
어드민
각 서버에 어드민 계정이 따로 있고, 공통적으로 다음 계정으로 생성됩니다.
email: admin@programmers.co.kr password: programmers
포스트를 남기기 위해서는 채널이 필요하기 때문에 채널 생성이 필요합니다.
채널 추가는 어드민 계정으로 가능하고 다음과 같이 요청을 보낼 수 있습니다.
POST /channels/create
Request Body
{ "authRequired": Boolean // 채널 내용을 로그인한 사람만 볼 수 있는지 여부 "description": String // 채널 설명 "name": String // 채널 이름 }
인증
로그인
사용자가 이메일과 비밀번호로 서비스에 로그인합니다.
POST /login
회원가입
사용자가 이메일과 비밀번호로 서비스에 가입합니다.
POST /signup
로그아웃
사용자가 로그아웃 합니다.
POST /logout
인증 확인
사용자가 인증이 되었는지 확인합니다.
GET /auth-user
사용자
사용자 목록
사용자 목록을 불러옵니다.
GET /users/get-users
현재 접속 중인 사용자 목록
현재 접속 중인 사용자 목록을 불러옵니다.
GET /users/online-users
사용자 정보
특정 사용자 정보를 불러옵니다.
GET /users/{userId}
프로필 이미지 변경
나의 프로필 이미지를 변경합니다.
POST /users/upload-photo
커버 이미지 변경
나의 커버 이미지를 변경합니다.
POST /users/upload-photo
설정
내 정보 변경
나의 정보를 변경합니다.
PUT /settings/update-user
비밀번호 변경
내 계정 비밀번호를 변경합니다.
PUT /settings/update-password
채널
채널 목록
채널 목록을 불러옵니다.
GET /channels
채널 정보
특정 채널 정보를 불러옵니다.(채널 이름이 한글일 때, 인코딩 필요)
GET /channel/{channelName}
포스트
특정 채널의 포스트 목록
특정 채널의 포스트 목록을 불러옵니다.
GET /posts/channel/{channelId}
특정 사용자의 포스트 목록
특정 사용자의 포스트 목록을 불러옵니다.
GET /posts/author/{authorId}
특정 채널에 포스트 작성하기
특정 채널에 포스트를 작성합니다.
POST /posts/create
특정 포스트 상세 보기
특정 포스트의 정보를 불러옵니다.
GET /posts/{postId}
Response
Post
내가 작성한 포스트 수정하기
내가 작성한 포스트를 수정합니다.
PUT /posts/update
Request Header
Authorization: bearer JWT토큰
Request Body
FormData
이미지를 삭제하려면
imageToDeletePublicId에 imagePublicId를 넣어주세요.postId: String title: String image: Binary | null imageToDeletePublicId: Optional channelId: String
내가 작성한 포스트 삭제하기
내가 작성한 포스트를 삭제합니다.
DELETE /posts/delete
좋아요
특정 포스트 좋아요
특정 포스트에 좋아요합니다.
POST /likes/create
특정 포스트 좋아요 취소
특정 포스트에 좋아요한 것을 취소합니다.
DELETE /likes/delete
댓글
특정 포스트에 댓글 달기
특정 포스트에 댓글을 작성합니다.
POST /comments/create
특정 포스트에 작성한 내 댓글 지우기
특정 포스트에 작성한 내 댓글을 삭제합니다.
DELETE /comments/delete
알림
검색
사용자 검색
사용자를 검색합니다.
GET /search/users/{query}
전체 검색 (포스트, 사용자)
포스트와 사용자를 검색합니다.
GET /search/all/{query}
나의 알림 목록
나의 알림 목록을 불러옵니다.
GET /notifications
알림 확인 처리
나에게 온 알림을 읽음처리 합니다.
PUT /notifications/seen
알림 생성
상대방에게 알림을 보냅니다.
POST /notifications/create
원래는 서버에서 해주는게 맞는 작업이지만 API 호출로 알림을 보낼 수 있도록 작성했습니다.
Request Header
Authorization: bearer JWT토큰
Request Body
notificationTypeId는 type에 해당하는 객체의 id를 넣어주세요.- COMMENT일 경우엔 댓글 id
- FOLLOW일 경우엔 팔로우 id
- LIKE일 경우엔 좋아요 id
- MESSAGE일 경우엔 메시지 id
postId는 type이 FOLLOW일 경우엔 null로 보내주세요.{ "notificationType": "COMMENT" | "FOLLOW" | "LIKE" | "MESSAGE", "notificationTypeId": String, "userId": String, "postId": Nullable<String> }
팔로우
특정 유저 팔로우
특정 유저를 팔로우합니다.
POST /follow/create
특정 유저 언팔
특정 유저를 언팔합니다.
DELETE /follow/delete
메시지
나의 메시지함 (소통한 유저 목록)
나와 메시지함을 불러옵니다.
GET /messages/conversations
특정 사용자와 소통한 메시지 목록
특정 사용자와 소통한 메시지 목록을 불러옵니다.
GET /messages
특정 사용자에게 메시지 전송
특정 사용자에게 메시지를 전송합니다.
POST /messages/create
메시지 확인 처리
특정 사용자와 나눈 메시지를 읽음처리 합니다.
PUT /messages/update-seen
Request Header
Authorization: bearer JWT토큰
Request Body
{ "sender": String // 사용자 id }
(User | Post)[]
모델 안내
API에 따라 모델 필드에서 일부분이 빠진 상태로 내려올 수 있습니다.
ex) 로그인 후 내려오는 User에는 프로필 이미지와 커버 이미지 필드가 제거됩니다.User
{ "coverImage": String, // 커버 이미지 "image": String, // 프로필 이미지 "role": String, "emailVerified": Boolean, // 사용되지 않음 "banned": Boolean, // 사용되지 않음 "isOnline": Boolean, "posts": Post[], "likes": Like[], "comments": String[], //-> Comment[]로 수정받음 "followers": [], "following": [ { "_id": "6169e91316cb2265df003c6d", "user": "6169e58216cb2265df003bf4", "follower": "6169e206aa57d952c6dc1edd", "createdAt": "2021-10-15T20:48:19.816Z", "updatedAt": "2021-10-15T20:48:19.816Z", "__v": 0 } ], "notifications": Notification[], "messages": Message[], "_id": String, "fullName": String, "email": String, "createdAt": String, "updatedAt": String }
Channel
{ "authRequired": Boolean, // 사용되지 않음 "posts": String[], "_id": String, "name": String, "description": String, "createdAt": String, "updatedAt": String }
Post
{ "likes": Like[], "comments": Comment[], "_id": String, "image": Optional<String>, "imagePublicId": Optional<String>, "title": String, "channel": Channel, "author": User, "createdAt": String, "updatedAt": String }
Like
{ "_id": String, "user": String, // 사용자 id "post": String, // 포스트 id "createdAt": String, "updatedAt": String }
Comment
{ "_id": String, "comment": String, "author": User, "post": String, // 포스트 id "createdAt": String, "updatedAt": String }
Notification
{ "seen": Boolean, "_id": String, "author": User, "user": User | String, "post": Nullable<String>, // 포스트 id "follow": Optional<String>, // 사용자 id "comment": Optional<Comment>, "message": Optional<String>, // 메시지 id "createdAt": String, "updatedAt": String }
Follow
{ "_id": String, "user": String, // 사용자 id "follower": String, // 사용자 id "createdAt": String, "updatedAt": String }
Conversation
{ "_id": String[], "message": String, "sender": User, "receiver": User, "seen": Boolean, "createdAt": String }
Message
{ "_id": String, "message": String, "sender": User, "receiver": User, "seen": Boolean, "createdAt": String, "updatedAt": String }