Repository navigation
Memo API Spec
⚠️ [통합됨] 2026-07-06 — 메모는 노트와 단일 도메인으로 병합되었습니다 (#740, PR #741).note.material_id를 nullable로 완화해 자료 종속 노트(material_id 있음)와 독립 노트(NULL)를 한 테이블/도메인으로 통합했다. API/api/notes, 라우트/notes, 사이드바 "노트". 아래 설계 문서는 분리 시절(Epic #718)의 기록이다.
범위: 독립 메모장 REST API. Study Planner 노트 API(
/planner/materials/{id}/notes,/planner/notes/{id})를 자료 종속 없이 최상위/memos로 재구성했다. 모든 응답은 orino 공통 envelope(code,data)를 따른다.
- 인증: 모든 엔드포인트 JWT 필요(미인증 401).
- Base path:
/api/memos - 성공 코드:
CustomResponseCode, 에러 코드:ErrorCode(GLB-ERR-XXX) — 에러 처리 컨벤션. -
content는 Tiptap 문서 JSON.
| Method | Path | 설명 |
|---|---|---|
| GET | /api/memos |
멤버의 메모 트리 조회 |
| POST | /api/memos |
메모 생성(최상위/하위) |
| GET | /api/memos/{id} |
메모 단건 상세(본문 포함) |
| PATCH | /api/memos/{id} |
제목/본문/부모/정렬 부분 수정(자동 저장) |
| DELETE | /api/memos/{id} |
메모 삭제(하위 CASCADE) |
멤버의 전체 메모를 트리로 반환한다. 본문(content)은 제외하고 구조·제목만 담는다.
응답 200
{
"code": "SUCCESS",
"data": {
"memos": [
{
"id": 1,
"title": "아이디어",
"parentId": null,
"sortOrder": 0,
"children": [
{ "id": 5, "title": "orino 개선", "parentId": 1, "sortOrder": 0, "children": [] }
]
},
{ "id": 2, "title": "장보기", "parentId": null, "sortOrder": 1, "children": [] }
]
}
}요청
{ "parentId": null, "title": "새 메모" }| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
| parentId | number|null | N | 부모 메모 id. 생략/NULL이면 최상위 |
| title | string | N | 생략 시 제목 없음
|
- 생성 시
content는 빈 doc({"type":"doc","content":[]}),sortOrder는 형제 최대값+1.
응답 201 — 생성된 메모 상세(§4 형식).
에러: 존재하지 않는 parentId → 404, 타인 메모 → 404.
응답 200
{
"code": "SUCCESS",
"data": {
"id": 5,
"parentId": 1,
"title": "orino 개선",
"sortOrder": 0,
"content": { "type": "doc", "content": [] },
"updatedAt": "2026-07-04T12:00:00Z"
}
}에러: 없음/타인 소유 → 404.
부분 수정. 전달된 필드만 갱신하며 idempotent 하다.
요청
{ "title": "제목", "content": { "type": "doc", "content": [] }, "parentId": 2, "sortOrder": 1 }| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
| title | string | N | 제목 변경 |
| content | object | N | 본문(Tiptap JSON) 저장. 빈 doc 방지 규칙 적용 |
| parentId | number|null | N | 부모 변경(이동). 자기/자손 지정 시 400 |
| sortOrder | number | N | 형제 정렬 |
응답 200 — 갱신 결과 메타(본문 제외).
{
"code": "SUCCESS",
"data": { "id": 5, "parentId": 2, "title": "제목", "sortOrder": 1, "updatedAt": "2026-07-04T12:03:00Z" }
}에러: 순환 참조 이동 → 400, 없음/타인 → 404.
해당 메모와 모든 하위 메모를 삭제한다(CASCADE).
응답 200 — 삭제 결과(빈 data 또는 삭제 id).
에러: 없음/타인 → 404.
| 노트 | 메모 |
|---|---|
GET /planner/materials/{mid}/notes |
GET /memos (자료 컨텍스트 제거) |
POST /planner/materials/{mid}/notes |
POST /memos |
GET /planner/notes/{id} |
GET /memos/{id} |
PATCH /planner/notes/{id} |
PATCH /memos/{id} |
DELETE /planner/notes/{id} |
DELETE /memos/{id} |
DTO·검증·응답 형식은 노트를 미러링하되 materialId 필드를 제거한다.