Participant API 문서 - PartyGwam/api GitHub Wiki

Participant & Owner API

목차

  • GET /parties/<slug>/participants/
  • POST /parties/<slug>/participants/
  • DELETE /parties/<slug>/participants/
  • GET /parties/<slug>/owner/
  • PUT /parties/<slug>/owner/

GET /parties/<slug>/participants/

파티의 모든 참여자 조회

Response Format - Success

성공 시 다음의 데이터와 함께 200 응답을 리턴.

{
    "success": true,
    "result": {
        "title": "배틀그라운드 스쿼드",
        "current_people": 2,
        "participants": [
            {
                "username": "샘플 유저 1",
                "profile_picture": "/assets/images/image_1513232511950_750.jpg"
            },
            {
                "username": "개발자",
                "profile_picture": null
            }
        ]
    },
    "message": null
}

Response Format - Failure

인증 토큰이 존재하지 않는 경우 401 응답을 리턴.
파티가 존재하지 않는 경우 404 응답을 리턴

POST /parties/<slug>/participants/

현재 로그인된 유저가 파티에 참여.

별도 데이터 필요없이 인증 토큰만 헤더에 포함시키면 됨!

Response Format - Success

성공 시 "참여자 전체 조회" API 의 데이터 형식과 동일하게 201 응답을 리턴

Response Format - Failure

실패 시 실패 사유에 따라 4xx 응답을 리턴:

  • 400 : 파티 참여가 불가능한 경우
    • 최대 인원이 다 찼거나
    • 이미 파티에 참여하였거나
    • 파티가 이미 시작한 경우
  • 401 : 인증 토큰이 없는 경우

DELETE /parties/<slug>/participants/

현재 로그인된 유저가 파티에 참여를 취소.

Response Format - Success

성공 시 별도의 데이터 없이 204 응답을 리턴

Response Format - Failure

실패 시 실패 사유에 따라 4xx 응답을 리턴:

  • 400 : 참여 취소가 불가능한 경우
    • 파티에 참여 조차도 하지 않은 경우
    • 파티 주최자인 경우
  • 401 : 인증 토큰이 없는 경우

GET /parties/<slug>/owner/

파티의 방장 조회

Response Format - Success

성공 시 다음의 데이터와 함께 200 응답을 리턴

{  
  "success": true,
  "result": {
    "title": "배틀그라운드 스쿼드",
    "party_owner": {
      "username": "샘플 유저 1",
      "profile_picture": "/assets/images/image_1513232511950_750.jpg"
    }
  },
  "message": null
}

Response Format - Failure

인증 토큰이 존재하지 않는 경우 401 응답을 리턴.
파티가 존재하지 않는 경우 404 응답을 리턴

PUT /parties/<slug>/owner/

파티 방장 넘겨주기

Request Format

새로이 방장이 될 사람의 닉네임을 json body 에 넣어서 보낼 것

{
  "party_owner": "string"
}

Response Format - Success

성공 시 다음의 데이터와 함께 200 응답을 리턴

{  
  "success": true,
  "result": {
    "title": "배틀그라운드 스쿼드",
    "party_owner": {
      "username": "샘플 유저 1",
      "profile_picture": "/assets/images/image_1513232511950_750.jpg"
    }
  },
  "message": null
}

Response Format - Failure

실패 시 실패 사유에 따라 4xx 응답을 리턴:

  • 400 : 방장 넘겨주기가 불가능한 경우
  • 401 : 인증 토큰이 없는 경우
  • 403 : 요청을 보낸 유저가 방장이 아닌 경우
⚠️ **GitHub.com Fallback** ⚠️