woowacourse-teams / 2021-zzimkkong

✅ 공간을 한 눈에, 예약은 한 번에!
https://zzimkkong.com
162 stars 18 forks source link

refactor: 맵 리스트를 API 명세에 맞게 마이그레이션 #976

Closed 2yunseong closed 11 months ago

2yunseong commented 11 months ago

구현 기능

API 분리

일단은 기존의 찜꽁의 기능과 현재 개발중인 기능을 mocking 함수에서 사용하기 위해, 기존의 api/api.ts 파일을 그대로 복사해 api-v2/api.ts 를 생성했습니다. 일단은 BASE_URL을 하드코딩없이 localhost 주소를 고정해두었습니다.

mockoon으로 mocking 할 경우, 7742번 포트를 사용해주시기 바랍니다. 시간 상 임의로 정한 점 양해 부탁드립니다!

API 명세에 따른 기능 구현

명세는 Open API 문서 를 참고해주시면 됩니다. 여기서 구현된 기능은 이슈(#975)에서 말씀드렸듯이, Map에 관한 GET, DELETE 기능이 마이그레이션이 필요했습니다.

아래 변경 전/후 스크린샷을 보면 어떤 점이 변경되었는지 가시적으로 이해하실 수 있으리라 생각합니다. 참고바랍니다. 변경 전 변경 후
image image

논의하고 싶은 내용

또 api v2를 하면서 고민한 부분이 있습니다. 일단은 api 관련 로직과 타입은 새로 정의해주었는데, (v2 postfix 로 작성된 네이밍은 모두 새로정의된 부분입니다.) query등은 기존의 코드를 수정하였습니다. query는 굳이 새로 정의해줄 필요가 없고 기존의 코드를 변경하면 좋다고 생각했는데, 어떻게 생각하시나요?

Close #975

2yunseong commented 11 months ago

@suyoungj

  1. 익숙한 방식으로 하다보니, 해당 방식으로 계속 진행했습니다! 혹시 걸리시는 부분이 있으신가요?
  2. 수정하겠습니다! 감사합니다 :)