ghdwlsgur/bread-crumbs

[팀 과제] 노션에서 브로드 크럼스 만들기 with Python

목표

노션과 유사한 간단한 페이지 관리 API를 구현해주세요. 각 페이지는 제목, 컨텐츠, 그리고 서브 페이지를 가질 수 있습니다. 또한, 특정 페이지에 대한 브로드 크럼스(Breadcrumbs) 정보도 반환해야 합니다.

요구사항

페이지 정보 조회 API: 특정 페이지의 정보를 조회할 수 있는 API를 구현하세요.

입력: 페이지 ID
출력: 페이지 제목, 컨텐츠, 서브 페이지 리스트, 브로드 크럼스 ( 페이지 1 > 페이지 3 > 페이지 5)
컨텐츠 내에서 서브페이지 위치 고려 X_

제출 방법 (팀단위)

과제 내용을 노션 혹은 github 등에 문서화해서 제출해주세요. (마감 9월 5일 오전 10시)

필수

테이블 구조
비지니스 로직 (Raw 쿼리로 구현 → ORM (X))

결과 정보

{
		"pageId" : 1,
		"title" : 1,
		"subPages" : [],
		"breadcrumbs" : ["A", "B", "C",] // 혹은 "breadcrumbs" : "A / B / C"
}

제출하신 과제에 대해서 설명해주세요. (”왜 이 구조가 최선인지?” 등)

테이블 구조

CREATE TABLE PAGE (
	id VARCHAR(255) PRIMARY KEY,
	title TEXT NOT NULL,
	content TEXT,
	parent_page_id VARCHAR(255),
	FOREIGN KEY (parent_page_id) REFERENCES PAGE(id)
);

비즈니스 로직

@ns.route("/<string:id>")
@ns.doc(params={'id': '페이지 아이디'})
class GetPage(Resource):
  @ns.doc(response={
    200: 'Success',
    404: 'Page Not Found',
    503: "Interner Server Error"
  })
  @ns.marshal_with(res_model)
  @ns.doc(description="페이지를 조회합니다.")
  def get(self, id: str) -> ResponseData:
    conn = None
    tree = Tree()

    try:
      conn = Database.get_connection(config)
      with conn.cursor() as cursor:
        query = """
        SELECT id, title, content, parent_page_id FROM PAGE
        """
        cursor.execute(query) # 쿼리 실행
        page_list = cursor.fetchall() # 전체 페이지 테이블 조회 결과 page_list에 저장

        # 1. page_list를 순회하면서 각 row마다 Node 생성
        for page in page_list:
          page_id = page['id']
          title = page['title']
          content = page['content']
          tree.create_node(page_id, title, content)

        # 2. 현재 페이지에 부모 페이지가 존재할 경우 현재 페이지 노드와 부모 페이지 노드를 서로 연결
        for page in page_list:
          page_id = page['id']
          parent_page_id = page['parent_page_id']
          if parent_page_id:
            tree.connect_node(parent_page_id, page_id)

      # 현재 조회하려는 노드를 변수에 저장
      curr_node = tree.get_node(id)
      # 만약 현재 조회하려는 노드가 존재하지 않는다면 404
      if not curr_node:
        response_data = ResponseData(None, None, None, None, None)
        return response_data.to_dict(), 404

      bread_crumbs = [node.id for node in tree.get_breadcrumbs(curr_node)]
      sub_pages = [sub_page.id for sub_page in curr_node.sub_page]

      response_data = ResponseData(curr_node.id, curr_node.title, curr_node.content, sub_pages, bread_crumbs)
      return response_data.to_dict(), 200

    except Exception as e:
      response_data = ResponseData(None, None, None, None, None)
      return response_data.to_dict(), 500
    finally:
      if conn:
        conn.close()

입력 데이터 (테스트 케이스)

동일 테이블에서 자기 참조 외래키를 사용하므로 테스트 케이스 입력시 parent_page_id가 None인 데이터 먼저 삽입

datas = [
      {"id": 5, "title": "Title1", "content": "Content1", "parent_page_id": None},
      {"id": 4, "title": "Title1", "content": "Content1", "parent_page_id": 5},
      {"id": 1, "title": "Title1", "content": "Content1", "parent_page_id": 5},
      {"id": 2, "title": "Title1", "content": "Content1", "parent_page_id": 4},
      {"id": 3, "title": "Title1", "content": "Content1", "parent_page_id": 4},
    ]

Response Data

{
  "id": "4",
  "title": "Title1",
  "content": "Content1",
  "sub_page": [
    "2",
    "3"
  ],
  "bread_crumbs": [
    "5",
    "4"
  ]
}

ghdwlsgur / bread-crumbs