Board API

공통 헤더

    {
        "Authorization": "Bearer " + Access Token,
        "Content-Type": "application/json",
        "Accept": "application/json"
    }

보드 전체 조회

• 상태 코드

  status code	설명
  200	요청 성공
  401	권한 에러
  500	서버 에러

• url

  GET /api/board
  

• request

  none
  

• response

  {
      
      "myBoards": [
          {
              "id": Number,
              "title": String,
              "color": String
          },
      ],
      "invitedBoards": [
          {
              "id": Number,
              "title": String,
              "color": String
          },
      ]
  }
  

보드 추가

• 상태 코드

  status code	설명
  201	요청 성공
  400	요청 바디가 올바르지 않음
  401	권한 에러
  500	서버 에러

• url

  POST /api/board
  

• request

  {
      "title": String (required),
      "color": String (required)
  }
  

• response

  {
      "id": Number
  }
  

보드 수정

• 상태 코드

  status code	설명
  204	요청 성공
  400	요청 바디가 올바르지 않음
  401	권한 에러
  404	보드 존재 X
  500	서버 에러

• url

  PUT /api/board/{boardId}
  

• request

  {
      "title": String (required)
  }
  

• response

      none
  

보드 삭제

• 상태 코드

  status code	설명
  204	요청 성공
  401	권한 에러
  404	보드 존재 X
  500	서버 에러

• url

  DELETE /api/board/{boardId}
  

• request

  none
  

• response

  none
  

보드에 유저 초대

• 상태 코드

  status code	설명
  201	요청 성공
  401	권한 에러
  404	보드 존재 X, 유저 존재 X
  500	서버 에러

• url

  POST /api/board/{boardId}/invitation
  

• request

  {
      "userId": Number (required)
  }
  

• response

  none
  

보드에 유저 나가기

• 상태 코드

  status code	설명
  204	요청 성공
  401	권한 에러
  404	보드 존재 X, 유저 존재 X
  500	서버 에러

• url

  DELETE /api/board/{boardId}/invitation/{invitationId}
  

• request

  none
  

• response

  none
  

보드 상세 조회

• 상태 코드

  status code	설명
  200	요청 성공
  401	권한 에러
  404	보드 존재 X, 유저 존재 X
  500	서버 에러

• url

  GET /api/board/{boardId}
  

• request

  none
  

• response

  {
      "id": Number,
      "creator": {
          "id": Number,
          "name": String,
          "profileImageUrl": String
      }
      "title": String,
      "color": String,
      "invitedUsers": [
          {
              "id": Number,
              "name": String,
              "profileImageUrl": String
          },
      ],
      "lists": [
          {
              "id": Number,
              "title": String,
              "position": Number
              "cards": [
                  {
                      "id": Number,
                      "title": String,
                      "position": Number,
                      "commentCount": Number,
                      "dueDate": date
                  },
              ]
          },
      ]
  }