Skip to content

Api 명세서 ‐ V2

Gyaak edited this page Oct 12, 2024 · 14 revisions

확인 필요한 부분

  • 태그 이동
  • url로 픽 조회(혹은 등록됬는지 여부 boolean으로 반환..?
  • 최근 등록한 픽 목록 조회

접속 도메인

Login Api

Api 상세

HTTP Method API Endpoint Description
GET /api/auth/login/kakao 카카오 로그인
GET /api/auth/login/naver 네이버 로그인
GET /api/auth/login/google 구글 로그인

Tag Api

요약

HTTP Method API Endpoint Description
GET /api/tags 태그 목록 조회
POST /api/tags 태그 생성
PUT /api/tags 태그 수정
DELETE /api/tags 태그 삭제

Api 상세

태그 목록 조회

HTTP Method API Endpoint Description
GET /api/tags 사용자가 등록한 전체 태그 목록을 조회합니다.
요청예시 응답예시
- [
 {
  "tagId" : 1,
  "tagName" : "태그이름예시1",
  "tagOrder" : 2,
  "colorNumber" : 25,
  "userId" : 1
 },
 {
  "tagId" : 2,
  "tagName" : "태그이름예시2",
  "tagOrder" : 4,
  "colorNumber" : 12,
  "userId" : 1
 }
]

태그 생성

HTTP Method API Endpoint Description
POST /api/tags 태그이름과 색을 받아 태그를 생성합니다.
요청예시 응답예시
{
 "tagName" : "태그이름1",
 "colorNumber" : 9
}
{
 "tagId" : 7,
 "tagName" : "태그이름1",
 "colorNumber" : 9
}

태그 수정

HTTP Method API Endpoint Description
PUT /api/tags 태그 이름과 색상을 수정합니다.
요청예시 응답예시
{
 "tagId": 2,
 "tagName" : "수정된태그이름222",
 "colorNumber" : 9
}

태그 이동

HTTP Method API Endpoint Description
PUT /api/tags/move 태그 순서를 변경합니다.
변경된 순서로 태그id 배열을 입력받습니다.
변경하려는 순서는 0부터 시작
요청예시 응답예시
{
 "tagId" : 2,
 "tagOrder" : 3
}
{
 "tagIdList" : [5, 7, 1, 2, 9, 3]
}

태그 삭제

HTTP Method API Endpoint Description
DELETE /api/tags/{tagId} 태그를 삭제합니다.
요청예시 응답예시

Pick Api

요약

HTTP Method API Endpoint Description
GET /api/picks/{pickId} 픽 상세 정보 조회
GET /api/picks?parentId={parentFolderId} 부모 폴더 픽 리스트 조회
GET /api/picks/unclassified 미분류 폴더 픽 리스트 조회
POST /api/picks 픽 생성
PUT /api/picks 픽 수정
DELETE /api/picks 픽 삭제

Api 상세

태그 목록 조회

Folder Api

요약

HTTP Method API Endpoint Description

Api 상세

Pick Api

요약

HTTP Method API Endpoint Description

Api 상세