Skip to content

API Document

Woody edited this page May 10, 2021 · 13 revisions

Base URL

목차

1. 게임 관련 URL

  • ⭐️ 해당 URL 요청에 대한 응답 형식은 크게 response와 message로 구성되어 있음
    • message는 큰 의미가 없기 때문에 요청 시 삭제 가능
    • response : {요청 데이터} 형식이 불필요 하다면 마찬가지로 삭제 가능(순수하게 요청한 데이터만 넘겨줄 수 있음)
{
  "response" : {요청한 데이터},
  "message" : "success"
}

1-1. 전체 대진표 목록 출력

{
 "response":
  [
    {
      "gameId":1,
      "home":
         {
            "teamId":13,
            "teamName":"Los Angeles Angels",
            "selected":false
         },
      "away":
         {
            "teamId":20,
            "teamName":"Oakland Athletics",
            "selected":false}
         },
    {
      "gameId":2,
      "home":
         {
            "teamId":16,
            "teamName":"Milwaukee Brewers",
            "selected":false
         },
      "away":
         {
            "teamId":22,
            "teamName":"Pittsburgh",
            "selected":false}
         },
    ...
  ],
 "message" : "success"
}

1-2. 대진표 목록 일부 출력

  • url : /game/{index} (http://54.180.73.20:8080/game/{index})
  • 4개 단위로 게임 대진표 출력
  • index 시작은 1부터
  • ( example )
    • /game/1 요청 시, game id 1~4까지
    • /game/2 요청 시, game id 5~8까지
{
 "response":
  [
    {
      "gameId":1,
      "home":
         {
            "teamId":13,
            "teamName":"Los Angeles Angels",
            "selected":false
         },
      "away":
         {
            "teamId":20,
            "teamName":"Oakland Athletics",
            "selected":false}
         },
    {
      "gameId":2,
      "home":
         {
            "teamId":16,
            "teamName":"Milwaukee Brewers",
            "selected":false
         },
      "away":
         {
            "teamId":22,
            "teamName":"Pittsburgh",
            "selected":false}
         },
    {
      "gameId":3,
      "home":
         {
            "teamId":28,
            "teamName":"Texas Rangers",
            "selected":false
         },
      "away":
         {
            "teamId":8,
            "teamName":"Cleveland Indians",
            "selected":false}
         }
    }
  ],
 "message" : "success"
}

1-3. 선택된 팀인지 여부 출력

  • url : /team/{teamId}/selected (http://54.180.73.20:8080/team/{teamId}/selected)

  • 현재는 선택 되었는지 안되었는지에 대한 정보만 출력 (isSelected 만 출력)

  • (1) 이미 선택된 팀일 경우

    • 아직 로그인 기능 구현이 안되어 있으므로 DB 상에는 모두 false 상태
    • 테스트를 위해서 teamId = 1인 팀의 경우 true로 리턴하도록 구현(하드코딩..;;)
{
   "isSelected":true
}
  • (2) 선택되지 않은 팀일 경우
    • ⭐️ 아직 선택되지 않은 팀의 경우 바로 각 팀에 대한 정보를 넘겨주는 기능 구현 시 문서 업데이트 할 예정
{
   "isSelected":false
}

Clone this wiki locally