아무래도 프론트랑, 백엔드를 같이 구현하다보니, 기능을 하나 추가할때마다 restapi를 하나씩 추가했는데 규칙도 없고, 유지보수도 어려워서 내가 미리 상용할 restapis를 정의하고 가능한 모든 기능에 대해서 백엔드에 구현하고, 이후에 작은 변경을 하는게 좋아보인다. 몇가지 규칙을 정해서 설계를 하고 백엔드 구성해보자

• 규칙

  • 리소스는 복수형 명사를 사용 (/dog -> /dogs)
  • domain/{service_name}/v2.0/users
  • /records?offset=100&limit=25

기능

• 부동산 개발 계획 포스트
• depth있게 보여주자, 1차로는 서울특별시, 경기도에 대해서 보여주기
• {지역별|기간별|거래타입} 실거래가, 평당거래액 조회
• {지역별|기간별|거래타입} 거래량 조회
• 전세/월세 비율
• 거래량, 거래액, 거래내역

• 랭킹 조회

  • {서울특별시|경기도}에서 가장 {거래량|신고가|평단가}이(가) 많은 지역은?
  • 입력: 지역, topic (예: /api/budongsan/top?q=서울특별시&topic=거래량&n=10)

• 최근 거래내역 조회

  • 지역, 단지별
  • /api/budongsan/records?q=서울특별시&startDt=2020-01&endDt=2020-07
  • common : /api/budongsan/records?q=서울특별시&startDt=2020-01&endDt=2020-07&tradeTp=rent

• 거래액 조회

  • {common}&groupBy=transaction_amount

• 평단가 조회

  • {common}&groupBy=amount_per_area

부동산 Rest Apis

/api/budongsan/{version}

실거래 데이터 조회

GET /api//budongsan/{version}/records