장고 심화 과정- 프로젝트 api문서 및 erd 그리고 wirelessframe

권수민·2023년 10월 5일
1

팀원들과 주제를 얘기하다,
지도를 불러와 중간지점을 선택하여 그 주변 맛집을 공유해주고 다이렉팅까지해주는 그런 서비스를 만들어 보자! 해서 주제를 그것으로 선택했다.

물론 리뷰게시글을 만들어서 추천기능을 넣어준 후 관련 가게에 포스팅을 모아 볼수도 있는 기능을 해 주려고 한다.

프로젝트 이름은 주제:부주제식으로 :

< 당장만나! : 어디서볼까? > 이렇게 정해보았다.

Wirelessframe

이렇게 간단하게 어떻식으로 페이지를 구성하고 기능을 넣어줄지에 대해서 rough하게 만들어 보았다.

ERD

ERD Cloud를 이용해서 모델링을 해보았다.

일단 최대한 생성해 놓을 부분은 해놓고 필요하지않으면 쓰지 않던가하는게, 추후에 추가해서 넣어주는것보다는 나을것 같아서 구성했다.

FK -> 1:many 관계있을때
one있는 곳이 아닌 many모델entity에 fk필드가 들어가있는것을 볼 수 있다!

리뷰entity를 중심으로 (->> : one ->> many:FK)

user ->> review : 유저는 많은 리뷰 생성가능/반면에하나의포스트안에 많은유저 불가능
user ->> comments : 유저는 많은 댓글 생성가능
user ->> likes : 유저는 많은 좋아요(리뷰당) 생성가능

review ->> likes : 리뷰는 많은 좋아요 가질수 있고
review ->> comments : 리뷰는 많은 댓글 가질 수 있고
review ->> photos : 리뷰는 많은 사진을 추가해 넣을 수 있다.

restaurant ->> review : 하나의 레스토랑이 많은 리뷰에 언급되니 많은리뷰를 가질수 있음

catagories ->> restaurant : 카테고리 (중식당, 양식당,카페...)는 레스토랑 태그안에 여러개 들어가질 수 있게 정해둠.

API 명세서:

일단 간단하게 KAKAO MAPS API를 불러오는거 제외하고 만들어 보았다.
DRF를 사용하고 serializer를 사용하다보니 여러 모듈을 상속시켜 api를 만들어 어느것을 어떻게 올려야하나 고민을했는데,

간단하게 postman활용해서 보내주고 확인했던 부분들, urls,views.py안에 있는 것들을 api 명세서에 넣어주면 되는것으로 보았다.

우리는 GUI가 깔끔한 GITBOOK을 apiDocs를 만들었다.

<Api 명세서>
https://800-1.gitbook.io/api-docs/

profile
초보개발자

0개의 댓글