폴더/픽 API 정의

[Gyaak]

ref: Raindrop 네트워크 요청 분석

API

---

/api/folders/{id}/parents

• api 설명 : 해당 폴더의 모든 부모를 응답
• 요청예시 : /api/folders/6/parents
• 응답예시 :

[
  {
    "id": 1,
    "name": "folderName1",
    "parentFolderId": null, // 최상위 폴더
    "childFolderList": [
      {
        "id": 2,
        "name": "folderName2",
        "parentFolderId": 1
      },
      {
        "id": 3,
        "name": "folderName3",
        "parentFolderId": 1
      },
      {
        "id": 4,
        "name": "folderName4",
        "parentFolderId": 1
      }
    ],
    "childPickList": [
      {
        "id": 1,
        "name": "pickName1",
        "parentFolderId": 1
      },
      {
        "id": 2,
        "name": "pickName2",
        "parentFolderId": 1
      }
    ]
  },
  {
    "id": 3,
    "name": "folderName3",
    "parentFolderId": 1,
    "childFolderList": [
      {
        "id": 6,
        "name": "folderName6",
        "parentFolderId": 3
      }
    ],
    "childPickList": []
  },
  {
    "id": 6,
    "name": "folderName6",
    "parentFolderId": 1,
    "childFolderList": [],
    "childPickList": [
      {
        "id": 3,
        "name": "pickName3",
        "parentFolderId": 6
      },
      {
        "id": 4,
        "name": "pickName4",
        "parentFolderId": 6
      },
      {
        "id": 5,
        "name": "pickName5",
        "parentFolderId": 6
      }
    ]
  }
]

위 응답은 다음 폴더구조를 나타낸것입니다.

folderName1
  | -- folderName2
  | -- folderName3
  |    | -- folderName6 (이 폴더를 조회 한 것)
  |    |   | -- pickName3
  |    |   | -- pickName4
  |    |   | -- pickName5
  |    |   | ----
  |    | ----
  | -- folderName4
  | -- pickName1
  | -- pickName2
  | ----

---

/api/folders/{id}/detail

• api 설명 : 해당 폴더의 자식 폴더와 픽들을 조회
• 요청예시 : /api/folders/3/detail
• 응답예시 :

{
  "id": 6,
  "name": "folderName6",
  "parentFolderId": 1,
  "childFolderList": [
    {
      "id": 7,
      "name": "folderName7"
    }
  ],
  "childPickList": [
    {
      "id": 3,
      "name": "pickName3",
      "parentFolderId": 6,
      "url": "pickUrl3",
      "memo": "pickMemo3",
      "tags": [
        {
          "id": 1,
          "name": "tagName1"
        }
      ]
    },
    {
      "id": 4,
      "name": "pickName4",
      "parentFolderId": 6,
      "url": "pickUrl4",
      "memo": "pickMemo4",
      "tags": [
        {
          "id": 2,
          "name": "tagName2"
        }
      ]
    },
    {
      "id": 5,
      "name": "pickName5",
      "parentFolderId": 6,
      "url": "pickUrl5",
      "memo": "pickMemo5",
      "tags": [
        {
          "id": 2,
          "name": "tagName2"
        },
        {
          "id": 1,
          "name": "tagName1"
        }
      ]
    }
  ]
}

위 응답은 다음 폴더구조를 나타낸것입니다.

folderName6
  | -- folderName7
  | -- pickName3 (tag1)
  | -- pickName4 (tag2)
  | -- pickName5 (tag2, tag1)
  | ----

---

/api/picks/{id}/detail

• api 설명 : 해당 픽의 상세정보를 조회
• 요청예시 : /api/folders/3/detail
• 응답예시 :

{
  "id": 3,
  "name": "pickName3",
  "parentFolderId": 6,
  "url": "pickUrl3",
  "memo": "pickMemo3",
  "tags": [
    {
      "id": 1,
      "name": "tagName1"
    }
  ]
}

@dmdgpdi 응답형식 확인해주세요.
@sangwonsheep @kimminkyeu api 형식 확인해주세요.

[sangwonsheep]

감사합니다!

[Gyaak]

REMIND
@Gyaak @dmdgpdi
자식폴더 / 자식픽 조회 메소드 분리 필요