/spes-backend

구름에서 주최한 Hello20thon 대상 Spes프로젝트의 백엔드입니다.

Primary LanguageTypeScript

프론트엔드 : https://github.com/junhoyeo/spes
사이트 : https://spes.now.sh

Spes Backend

사용되는 모델

  1. User

    {
  "_id": "objectID",
  "username": "string",
  "email": "string",
  "profile": "string",
  "achievement": [12, 18]
}

    achievement[0] : 올린 포스트중 closed(인정) 된 것의 수
    achievement[1] : 올린 모들 포스트의 수
    달성률 = achievement[0] / achievement[1] * 100

  2. Post

    {
  "_id": "objectID",
  "image": "string (link)",
  "content": "string",
  "author": "userID",
  "agreedUsers": ["userObjectId"],
  "agreed": true,
  "created": 12808048528,
  "closed": false
}

    agreed : 동의 여부, 사용자에 따라 다르다.
    closed : 투표가 끝났는지 여부, 방에 있는 모든 사람이 동의 하면 true가 되고 더이상 투표할 수 없다.

  3. Room

    {
  "_id": "objectID",
  "title": "string",
  "goal": "string",
  "continuous": true,
  "finish": 12808048528,
  "finished": false,
  "users": ["User 모델"],
  "posts": ["Post 모델"]
}

    finished : 방이 끝났는지 여부, finish날짜가 지나면 true로 되며, 방이 읽기 전용이 된다.

인증

회원가입

POST /api/auth/register

request

{
  "username": "string",
  "email": "string (unique)",
  "password": "string",
  "profile": "string (link)"
}

로그인

POST /api/auth/login

request

{
  "email": "string",
  "password": "string"
}

response

{
  "token": "string",
  "user": "User 모델"
}

사용자 (토큰 필요)

아이디로 사용자 정보 가져오기

GET /api/user/:id

response

User 모델

모든 사용자 정보 가져오기 (순위 가져오기)

GET /api/user

response

{
  "users": ["User 모델"]
}

달성률 순위별로 정렬 되어서 온다. (인덱스가 낮을수록 달성률 높음)

방 (토큰 필요)

방 목록

GET /api/room

response

{
  "rooms": ["Room 모델"]
}

현재 사용자(토큰 주인)의 방 목록을 구함

방 정보 (토큰 Optional)

GET /api/room/:roomID

response

Room 모델 (토큰이 없다면 Post의 agreed가 false로 온다)

방 생성

POST /api/room

request

{
  "title": "string",
  "goal": "string",
  "continuous": true,
  "finish": 1580784527
}

response

{
  "_id": "objectID"
}

방 입장 (토큰 불필요)

POST /api/room/:roomID

토큰 주인을 해당 방에 넣어준다.

포스트 (토큰 필요)

포스트 생성

POST /api/post/:roomID

request

{
  "content": "string",
  "image": "string (link, optional)"
}

response

{
  "_id": "objectID"
}

토큰 주인이 글을 쓴다.

포스트 정보

GET /api/post/:postId

response

POST 모델

투표

POST /api/post/vote/:postID

response

{
  "agreedUsers": ["userObjectId"],
  "agreed": true
}

토큰 주인의 투표(동의) 여부를 토글한다.
closed된 포스트라면 에러 발생 "This post's vote is closed

이미지

이미지 저장

POST /api/image

request

{
  "image": "Image"
}

response

{
  "fileName": "string"
}

이미지 불러오기

GET /api/image/:fileName