당근 마켓 address domain API 완성 - 9일차

주소 도메인에 관련한 모든 API를 작성하였다.

base url 은 skrrr.shop이다.

 

정리를 해보자면 다음과 같다.

 

 

1. 검색으로 동네 찾기

• GET skrrr.shop/address?search={search}&townId={townId}

검색할 내용과 현재 유저가 위치한 동네의 townId를 입력받는다.

유저의 현재 위치를 알 수 없는 경우 townId에 -1을 넣는다.

townId에 따라서 검색 내용이 townId에 가까운 순으로 정렬된다.

 

 

2. 현재 위치로 주변 동네 찾기

• GET skrrr.shop/address/location?townId={townId}

현재 유저가 위치한 동네의 townId를 입력받는다.

입력받은 townId를 이용하여 가까운 순으로 주변 동네를 나타낸다.

 

 

3. 동네 id로 동네 이름 가져오기

• GET skrrr.shop/address/:townId

townId를 통해 townName을 얻어야 하는 상황들이 있기에 추가하였다.

 

4. 동네 정보 가져오기

• GET skrrr.shop/address/info

유저가 현재 선택한 동네 id, 인증 여부, 설정한 범위 가져오기

게시물을 확인함에 있어 현재 동네, 인증 여부, 설정된 범위를 알아야 하기 때문에 추가하였다. 

 

 

5.  내 동네 바꾸기

• PATCH skrrr.shop/address/change/:townId

현재 선택하고 있는 2개의 동네 중 바꾸고 싶은 동네의 townId를 입력받는다.

 

 

 

6.  설정된 동네들 조회

• GET skrrr.shop/address/user-address

당근마켓은 동네를 2개까지 선택할 수 있다. 선택한 동네들을 리스트의 형식으로 반환한다. 

 

 

 

7. 내 동네 설정 삭제

• PATCH skrrr.shop/address/:townId

선택된 동네들 중 삭제하고 싶은 동네의 id를 받아 해당 동네를 삭제처리한다.

 

 

8. 내 동네 추가

• POST skrrr.shop/address/:townId

추가하고 싶은 동네의 townId를 입력받아 주소목록에 추가한다.

 

 

9. 동네의 범위 별 근처 동네 리스트 반환

• GET skrrr.shop/address/near?townId={townId}

범위는 0단계부터 3단계까지 존재한다.

townId를 통해 특정 동네의 0부터 3단계까지의 근처 동네들을 리스트의 형식으로 반환한다.총 4개의 리스트를 반환한다.

 

 

10. 동네 설정 범위 변경

• PATCH skrrr.shop/address/:townId/:range

동네의 범위를 변경하여 거래하고 싶은 동네들을 설정한다.

 

 

 

11. 동네 인증 추가

• skrrr.shop/address/certification/:townId

townId로 현재 내가 위치한 동네를 받아오고 현재 내가 선택한 위치와 비교하여 같으면 인증 처리를 진행하고 다르면 인증 처리를 하지 않는다.

 

 

12. 동네의 이름을 통해 동네 Id 가져오기

• skrrrr.shop/address/townId?city={city}&district={district}&townName={townName}

대부분의 api에서 townId를 이용하기 때문에 동네 이름을 townId로 변경해야한다. 따라서 이 API를 작성하였다.

 

 

 

대부분의 API에서 토큰을 사용해야한다. 

 

1,2,3,9, 12번은 토큰을 사용할 필요가 없어서 직접 실행해볼 수 있다.

townId는 1~6561번까지 존재한다.

 

 

 

깃허브 

https://github.com/seong-wooo/Carrot_Market_Server