[Server➡️Unity] 영상과 관련된 통신 API 정보 (최근 업데이트 23/11/27)

[numerical43]

문서 업데이트

23/11/03 업데이트

1) 3. 숏폼 전체 조회 : 연관된 인터랙티브 무비의 url, no, choice까지 함께 조회하도록 수정

23/11/08 업데이트

1) 3. 숏폼 전체 조회 : 숏폼의 좋아요 수, 사용자 본인이 각 숏폼에 좋아요를 했는지 여부를 함께 조회하도록 수정
2) 4. 숏폼 조회 : 숏폼의 좋아요 수, 사용자 본인이 해 숏폼에 좋아요를 했는지 여부를 함께 조회하도록 수정
3) 6. 좋아요 : 좋아요 API 항목 추가

23/11/27 업데이트

1) 3. 숏폼 전체 조회: 쿼리 스트링인 ?=language를 통해 한국어 자막/영어 자막 동영상을 조회하도록 수정
2) 4. 숏폼 조회 : 쿼리 스트링인 ?=language를 통해 한국어 자막/영어 자막 동영상을 조회하도록 수정
3) 5. 인터랙티브 무비 조회 : 쿼리 스트링인 ?=language를 통해 한국어 자막/영어 자막 동영상을 조회하도록 수정
4) 6. 좋아요 : GET이라고 오타난 부분을 제대로된 값인 POST로 수정

카테고리

통신 관련

전달 사항

영상 저장, 조회와 관련된 API의 요청 경로와 데이터들에 대해 정리했습니다.
캔바에 있는 화면 시나리오를 보고 필요하다고 생각되는 정보들을 채운 것이기 때문에 유니티와 생각의 차이가 있는 부분도 있을 것이라고 생각합니다. 보시고 통신 시 문제가 되는 부분이나 이해가 잘안가는 부분 등 수정해야하는 사항이 있다면 알려주시면 감사하겠습니다!

특히 숏폼과 인터랙티브 무비의 경우, 팀원분들이 알고계시는 것과 데이터베이스의 분류가 조금 다릅니다.

선택지를 통해서만 조회되는 영상은 "인터랙티브 무비"에 분류되어있으며, 영상 리스트를 통해 조회하는 일반 숏폼과, 팀에서 말하는 인터랙티브무비의 첫번째 영상 (선택지를 고를 수 있는 영상)은 "숏폼"에 분류되어있습니다.

1. 숏폼 저장

✔️http 요청 경로 : POST http://주소/short-form-firebase

유니티 ➡️ 서버 전달 데이터

form-data

• video : 동영상
• title (String) : 제목
• description (String) : 동영상에 대한 설명

서버 ➡️ 유니티 반환 데이터

• shortFormNo (Long) : 숏폼 번호
• thumbnail url (String) : 숏폼 썸네일 url
• url (String) : 숏폼 동영상 url

2. 인터랙티브 무비 저장

✔️http 요청 경로 : POST http://주소/interactive-movie

유니티 ➡️ 서버 전달 데이터

form-data

• video1 : 첫번째 영상
• video2 : 선택지 1 영상
• video3 : 선택지 2 영상
• title (String) : 제목
• description (String) : 영상 설명
• choice1 (String) : 선택지 1 텍스트
• choice2 (String) : 선택지 2 텍스트

서버 ➡️ 유니티 반환 데이터

• shortFormNo (Long) : 숏폼 번호 (첫번째 영상 번호), 인터랙티브 무비의 경우 null로 들어감.
• interactiveMovieNo (Long) : 인터랙티브 무비 번호 (두번째, 세번쨰 영상 번호), 숏폼의 경우 null로 들어감.
• thumbnail url (String) : 썸네일 url
• url (String) : 동영상 url
• sequence (int) : 영상의 순서(0, 1, 2)

3. 숏폼 전체 조회

이전 버전 (23/11/03 이전)

---

✔️http 요청 경로 : GET http://주소/short-form

◾유니티 ➡️ 서버 전달 데이터
없음

◾서버 ➡️ 유니티 반환 데이터

• shortFormNo : 숏폼 번호
• title (String) : 제목
• thumbnailUrl (String) : 썸네일 url
• url (String) : 영상 url
• description (String) : 영상 설명
• memberName (String) : 영상 제작자 이름
• date (Date) : 영상 제작 날짜
• isInteractiveMovie : 이 숏폼과 연결된 인터랙티브 무비가 있는지 없는지

---

이전 버전 (23/11/08 이전)

---

✔️http 요청 경로 : GET http://주소/short-form

유니티 ➡️ 서버 전달 데이터

없음

서버 ➡️ 유니티 반환 데이터

• shortFormNo : 숏폼 번호
• title (String) : 제목
• thumbnailUrl (String) : 썸네일 url
• url (String) : 영상 url
• description (String) : 영상 설명
• memberName (String) : 영상 제작자 이름
• date (Date) : 영상 제작 날짜
• isInteractiveMovie : 이 숏폼과 연결된 인터랙티브 무비가 있는지 없는지
• interactiveDTOS : 이 숏폼과 연결된 인터랙티브 무비의 정보 (연관된 인터랙티브 무비가 없으면 null)
  • url (String) : 선택지 1 영상의 url
  • choice (String) : 선택지 1 텍스트

---

이전 버전 (23/11/27 이전)

---

✔️http 요청 경로 : GET http://주소/short-form

유니티 ➡️ 서버 전달 데이터

없음

서버 ➡️ 유니티 반환 데이터

• shortFormNo : 숏폼 번호
• title (String) : 제목
• thumbnailUrl (String) : 썸네일 url
• url (String) : 영상 url
• description (String) : 영상 설명
• memberName (String) : 영상 제작자 이름
• date (Date) : 영상 제작 날짜
• isInteractiveMovie : 이 숏폼과 연결된 인터랙티브 무비가 있는지 없는지
• isLike (Boolean) : 사용자 본인이 해당 숏폼에 좋아요를 했는지 여부
• shortFormLikeCnt (int) : 해당 숏폼의 좋아요 수
• interactiveDTOS : 이 숏폼과 연결된 인터랙티브 무비의 정보 (연관된 인터랙티브 무비가 없으면 null)
  • url (String) : 선택지 1 영상의 url
  • choice (String) : 선택지 1 텍스트

---

✔️http 요청 경로 : GET http://주소/short-form?language=kr

유니티 ➡️ 서버 전달 데이터

?language= 뒤에 현재 유저의 언어 설정에 따라 kr(한국어), eng(영어)를 붙여서 요청을 보내주시면 됩니다.

서버 ➡️ 유니티 반환 데이터

• shortFormNo : 숏폼 번호
• title (String) : 제목
• thumbnailUrl (String) : 썸네일 url
• url (String) : 영상 url (kr이면 한국어 자막, eng면 영어 자막)
• description (String) : 영상 설명
• memberName (String) : 영상 제작자 이름
• date (Date) : 영상 제작 날짜
• isInteractiveMovie : 이 숏폼과 연결된 인터랙티브 무비가 있는지 없는지
• isLike (Boolean) : 사용자 본인이 해당 숏폼에 좋아요를 했는지 여부
• shortFormLikeCnt (int) : 해당 숏폼의 좋아요 수
• interactiveDTOS : 이 숏폼과 연결된 인터랙티브 무비의 정보 (연관된 인터랙티브 무비가 없으면 null)
  • url (String) : 선택지 1 영상의 url
  • choice (String) : 선택지 1 텍스트

4. 숏폼 조회 (하나의 동영상을 클릭하여 시청할 때)

이전 버전 (23/11/08 이전)

---

✔️http 요청 경로 : GET http://주소/short-form/{shortFormNo}

유니티 ➡️ 서버 전달 데이터

{shortFormNo} 부분에 조회하고자하는 숏폼의 번호를 넣어서 요청해주시면 됩니다.

서버 ➡️ 유니티 반환 데이터

• 하나의 숏폼일 경우
  • shortFormNo (Long) : 숏폼 번호
  • title (String) : 영상 제목
  • thumbnailUrl (String) : 썸네일 url
  • url (String) : 영상 url
  • description (String) : 영상 설명
  • memberName (String) : 영상 제작자 이름
  • date (Date) : 영상 제작 날짜
  • isInteractiveMovie (Boolean) : 이 숏폼과 연결된 인터랙티브 무비가 있는지 없는지
  • interactiveDTOS : null

• 연결된 인터랙티브 무비가 있을 경우
  • shortFormNo (Long) : 숏폼 번호
  • title (String) : 영상 제목
  • thumbnailUrl (String) : 썸네일 url
  • url (String) : 영상 url
  • description (String) : 영상 설명
  • memberName (String) : 영상 제작자 이름
  • date (Date) : 영상 제작 날짜
  • interactiveMovie (Boolean) : 이 숏폼과 연결된 인터랙티브 무비가 있는지 없는지
  • interactiveDTOS : 이 숏폼과 연결된 인터랙티브 무비의 정보
    • url (String) : 선택지 1 영상의 url
    • choice (String) : 선택지 1 텍스트

---

이전 버전 (23/11/27 이전)

---

✔️http 요청 경로 : GET http://주소/short-form/{shortFormNo}

유니티 ➡️ 서버 전달 데이터

{shortFormNo} 부분에 조회하고자하는 숏폼의 번호를 넣어서 요청해주시면 됩니다.

서버 ➡️ 유니티 반환 데이터

• 하나의 숏폼일 경우
  • shortFormNo (Long) : 숏폼 번호
  • title (String) : 영상 제목
  • thumbnailUrl (String) : 썸네일 url
  • url (String) : 영상 url
  • description (String) : 영상 설명
  • memberName (String) : 영상 제작자 이름
  • date (Date) : 영상 제작 날짜
  • isInteractiveMovie (Boolean) : 이 숏폼과 연결된 인터랙티브 무비가 있는지 없는지
  • isLike (Boolean) : 사용자 본인이 해당 숏폼에 좋아요를 했는지 여부
  • shortFormLikeCnt (int) : 해당 숏폼의 좋아요 수
  • interactiveDTOS : null

---

✔️http 요청 경로 : GET http://주소/short-form/{shortFormNo}?language=kr

유니티 ➡️ 서버 전달 데이터

{shortFormNo} 부분에 조회하고자하는 숏폼의 번호를 넣고,
?language= 뒤에 현재 유저의 언어 설정에 따라 kr(한국어), eng(영어)를 붙여서 요청을 보내주시면 됩니다.

서버 ➡️ 유니티 반환 데이터

• 하나의 숏폼일 경우
  • shortFormNo (Long) : 숏폼 번호
  • title (String) : 영상 제목
  • thumbnailUrl (String) : 썸네일 url
  • url (String) : 영상 url (kr이면 한국어 자막, eng면 영어 자막)
  • description (String) : 영상 설명
  • memberName (String) : 영상 제작자 이름
  • date (Date) : 영상 제작 날짜
  • isInteractiveMovie (Boolean) : 이 숏폼과 연결된 인터랙티브 무비가 있는지 없는지
  • isLike (Boolean) : 사용자 본인이 해당 숏폼에 좋아요를 했는지 여부
  • shortFormLikeCnt (int) : 해당 숏폼의 좋아요 수
  • interactiveDTOS : null

이전 버전 (23/11/27 이전)

---

✔️http 요청 경로 : GET http://주소/short-form/{shortFormNo}

유니티 ➡️ 서버 전달 데이터

{shortFormNo} 부분에 조회하고자하는 숏폼의 번호를 넣어서 요청해주시면 됩니다.

서버 ➡️ 유니티 반환 데이터

• 연결된 인터랙티브 무비가 있을 경우
  • shortFormNo (Long) : 숏폼 번호
  • title (String) : 영상 제목
  • thumbnailUrl (String) : 썸네일 url
  • url (String) : 영상 url
  • description (String) : 영상 설명
  • memberName (String) : 영상 제작자 이름
  • date (Date) : 영상 제작 날짜
  • interactiveMovie (Boolean) : 이 숏폼과 연결된 인터랙티브 무비가 있는지 없는지
  • isLike (Boolean) : 사용자 본인이 해당 숏폼에 좋아요를 했는지 여부
  • shortFormLikeCnt (int) : 해당 숏폼의 좋아요 수
  • interactiveDTOS : 이 숏폼과 연결된 인터랙티브 무비의 정보
    • url (String) : 선택지 1 영상의 url
    • choice (String) : 선택지 1 텍스트

---

✔️http 요청 경로 : GET http://주소/short-form/{shortFormNo}?language=kr

유니티 ➡️ 서버 전달 데이터

{shortFormNo} 부분에 조회하고자하는 숏폼의 번호를 넣고,
?language= 뒤에 현재 유저의 언어 설정에 따라 kr(한국어), eng(영어)를 붙여서 요청을 보내주시면 됩니다.

서버 ➡️ 유니티 반환 데이터

• 연결된 인터랙티브 무비가 있을 경우
  • shortFormNo (Long) : 숏폼 번호
  • title (String) : 영상 제목
  • thumbnailUrl (String) : 썸네일 url
  • url (String) : 영상 url (kr이면 한국어 자막, eng면 영어 자막)
  • description (String) : 영상 설명
  • memberName (String) : 영상 제작자 이름
  • date (Date) : 영상 제작 날짜
  • interactiveMovie (Boolean) : 이 숏폼과 연결된 인터랙티브 무비가 있는지 없는지
  • isLike (Boolean) : 사용자 본인이 해당 숏폼에 좋아요를 했는지 여부
  • shortFormLikeCnt (int) : 해당 숏폼의 좋아요 수
  • interactiveDTOS : 이 숏폼과 연결된 인터랙티브 무비의 정보
    • url (String) : 선택지 1 영상의 url
    • choice (String) : 선택지 1 텍스트

5. 인터랙티브 무비 조회 (숏폼 시청 후 선택지를 클릭하여 인터랙티브 무비를 시청할 때)

이전 버전 (23/11/27)

---

✔️http 요청 경로 : GET http://주소/interactive-movie/{inerativeMovieNo}

유니티 ➡️ 서버 전달 데이터

{interactiveMovieNo} 부분에 조회하고자하는 인터랙티브 무비의 번호를 넣어서 요청해주시면 됩니다.

서버 ➡️ 유니티 반환 데이터

• interactiveMovieNo (Long) : 인터랙티브 무비 번호
• title (String) : 영상 제목
• thumbnailUrl (String) : 썸네일 url
• url (String) : 영상 url
• description (String) : 영상 설명
• memberName (String) : 영상 제작자 이름
• date (Date) : 영상 제작 날짜
• sequence (int) : 영상 순서 (연결되어있는 3개의 영상 중 순서)

(⬆️10월 27일 오후 3시 15분 이미지 수정)

---

✔️http 요청 경로 : GET http://주소/interactive-movie/{inerativeMovieNo}?language=kr

유니티 ➡️ 서버 전달 데이터

{interactiveMovieNo} 부분에 조회하고자하는 인터랙티브 무비의 번호를 넣고,
?language= 뒤에 현재 유저의 언어 설정에 따라 kr(한국어), eng(영어)를 붙여서 요청을 보내주시면 됩니다.

서버 ➡️ 유니티 반환 데이터

• interactiveMovieNo (Long) : 인터랙티브 무비 번호
• title (String) : 영상 제목
• thumbnailUrl (String) : 썸네일 url
• url (String) : 영상 url (kr이면 한국어 자막, eng면 영어 자막)
• description (String) : 영상 설명
• memberName (String) : 영상 제작자 이름
• date (Date) : 영상 제작 날짜
• sequence (int) : 영상 순서 (연결되어있는 3개의 영상 중 순서)

6. 좋아요 (해당 영상의 좋아요)

좋아요, 좋아요 취소 아래 경로로 같은 요청을 보내주시면 됩니다.

✔️http 요청 경로 : POST http://주소/short-form/{shortFormNo}/like

유니티 ➡️ 서버 전달 데이터

{shortFormNo} 부분에 현재 보고있는 숏폼의 번호를 넣어서 요청해주시면 됩니다.

서버 ➡️ 유니티 반환 데이터

• like (boolean) : 좋아요를 클릭한 후 좋아요의 상태 (true일 경우 좋아요, false일 경우 좋아요X)

요청 사항

No response

첨부 코드

화이팅!!

[JCURVEs]

영상 관련된 정보들을 REST API로 받을 수 있을까요?

[numerical43]

영상 관련된 정보라면 영상 제목이랑 설명과 같은 정보들을 말씀하시는건가요? 그런거라면 위에 반환 데이터에 있는 정보들이 rest api 요청 시 유니티가 받는 정보입니다! 혹시 더 필요한 정보가 있으신가요?

[JCURVEs]

좋아요 수에 대한 통신 정보는 어디서 확인가능할까요??

[numerical43]

댓글 달린 걸 지금 봤네요 죄송합니다...ㅠㅠ 숏폼 전체 조회랑 상세 조회 할 때 좋아요 수, 본인이 해당 영상에 좋아요를 했는지 여부도 같이 표시하려고합니다! 기능 자체는 완성되어있고, 다음 번 서버 업데이트할 때 반영될 예정입니다.

[JCURVEs]

네 감사합니다!