(1) cardset 보기 페이지

• Page URL : /cardsets/:id
  

① 현재 cardset 정보(id, 제목, 자식 노드 정보) 불러오기

📤 Request

URL

GET /api/cardsets/{cardset의 id}/info

📢 Response

Name	Type	Description
id	int	cardset의 id
name	string	cardset의 title
cardSetCount	int	자식 노드들 중 cardset의 개수
cardCount	int	자식 노드들 중 card의 개수

예시

• 📤 Request

GET /api/1/info

• 📢 Response

{
	id: 1,
    name: '운영체제',
    cardSetCount: 2,
    cardCount: 2,
}

---

② cardset의 자식 노드(card, cardset) 불러오기

• 바로 아래 연결된 자식 노드까지만 불러오기 → depth = 1

📤 Request

URL

GET /api/cardsets/{cardset의 id}/children

📢 Response

• Response 형태는 [card 또는 cardset이 저장된 JSON Array]

ⓐ if → card

Name	Type	Description
id	int	card의 id
type	string	type: 'CARD'
title	string	card의 question

ⓑ if → cardset

Name	Type	Description
id	int	cardset의 id
type	string	type: 'CARDSET'
title	string	cardset의 title

예시

• 📤 Request

GET /api/cardsets/1/children

• 📢 Response

[
	{
    	id: 2,
        type: 'CARD',
        title: '운영체제란?',
    },
    {
    	id: 3,
        type: 'CARDSET',
        title: '운영체제 처리 방식'
    },
    {
    	id: 4,
        type: 'CARD',
        title: '운영체제의 사용 목적은?',
    },
]

---

③ sidebar에 보이는 root cardset 불러오기

• 가장 상위 root cardset들의 info 보여주기
• root cardset들의 상위 cardset을 임의로 만들고 그것의 id=1이라고 생각하자.

📤 Request

URL

GET /api/cardsets/1/children

📢 Response

• Response 형태는 [각각의 root 정보가 담긴 JSON Array]

Name	Type	Description
id	int	root cardset의 id
type	string	type: 'CARDSET'
title	int	cardset의 title

예시

• 📤 Request

GET /api/cardsets/1/children

• 📢 Response

[
	{
    	id: 3,
        type: 'CARDSET',
        title: '운영체제',
    },
    {
    	id: 6,
        type: 'CARDSET',
        title: '알고리즘',
    },
]

---

(2) cardset 수정 페이지

• Page URL : /studio/:id
  

✨참고

1. 카드를 생성하고 save 버튼을 누를 때
   • frontend에서 [새롭게 생성한 카드 list]와 [수정한 카드 list]와 [수정된 cardset 제목]을 가지고 있다가
   • save 버튼을 누르면 각각을 for문으로 돌아서 각각의 card를 POST로 보낸다.

2. add cardset 버튼을 누를 때
   • 현재까지의 수정 내용을 바탕으로 1번 과정(카드 저장 요청)을 진행한다.
   • new cardset 생성 요청을 보낸다. body에 { name : 'Untitled' }를 담아서 보내고 응답으로 new cardset의 cardset id를 받는다.
   • cardset id를 가지고 URL이 /studio/:id인 페이지를 호출해 새로운 studio page로 이동한다.

① 새롭게 만든 카드 저장하기

📤 Request

URL

POST /api/cardsets/{cardset의 id}/card

🧾 Parameter

Name	Type	Description
question	string	card의 질문
answer	string	card의 정답

📢 Response

Name	Type	Description
id	int	만들어진 card의 id
question	string	card의 질문
answer	string	card의 정답

예시

• 📤 Request

POST /api/cardsets/1/card
{
	question: '사과를 영어로?',
    description: 'apple',
}

• 📢 Response

{
	id: 2,
	question: '사과를 영어로?',
    description: 'apple',
}

---

② 기존 카드 수정하기

📤 Request

URL

PATCH /api/cardsets/{cardset의 id}/card/{수정한 card의 id}

🧾 Parameter

Name	Type	Description
question	string	card의 질문
answer	string	card의 정답

📢 Response

Name	Type	Description
id	int	만들어진 card의 id
question	string	card의 질문
answer	string	card의 정답

예시

• 📤 Request

PATCH /api/1/card/2
{
	question: '사과를 영어로?',
    description: 'apple',
}

• 📢 Response

{
	id: 2,
	question: '사과를 영어로?',
    description: 'apple',
}

---

③ 새로운 cardset 생성 요청 보내기

• add cardset 버튼 클릭 시 실행

📤 Request

URL

POST /api/cardsets/{cardset의 id}/cardset

🧾 Parameter

Name	Type	Description
name	string	'Untitled'를 보낸다

📢 Response

Name	Type	Description
id	int	만들어진 new cardset의 id

예시

• 📤 Request

POST /api/cardsets/1{cardset의 id}/cardset
{
	name: '자료구조',
}

• 📢 Response

{
	id: 15,
}

---

④ 현재 cardset의 title 수정

📤 Request

URL

PATCH api/cardsets/{수정된 현재 cardset의 id}

🧾 Parameter

Name	Type	Description
id	int	수정된 cardset의 id
name	string	수정할 cardset의 제목

📢 Response

🌟보류! 어떤걸 응답으로 줄지 미정...

Name	Type	Description
name	string	수정된 cardset의 제목

예시

• 📤 Request

PATCH api/cardsets/1
{
	id: 1,
	name: '알고리즘',
}

• 📢 Response

{
	name: '알고리즘',
}

---

⑤ 현재 cardset의 cards 가져오기

📤 Request

URL

GET /api/cardsets/{cardset의 id}/cards

📢 Response

• cards를 JSON Array로 준다.

Name	Type	Description
id	int	card id
question	string	card 질문
answer	string	card 정답
title	string	card가 속한 cardset의 title

예시

• 📤 Request

GET /api/cardsets/1/cards

• 📢 Response

[
	{
    	id: 1,
        question: '1+1?',
        answer: '2',
    },
    {
    	id: 14,
        question: '2+2?',
        answer: '4',
    },
]