Repository navigation
API
mon823 edited this page Jun 18, 2021
·
4 revisions
| API Path | Method | 설명 | |
|---|---|---|---|
| login | /auth/login | post | 로그인 |
| logout | /auth/logout | post | 로그아웃 |
| find-id | /auth/find-id | post | 아이디 찾기 |
| find-pw | /auth/find-pw | post | 비밀번호 찾기(변경) |
| change-pw | /auth/change-pw | post | 비밀번호 변경 |
| reg ✅ | /reg | post | 회원가입 |
| reg-e-mail | /reg/email | get | e-mail 인증 |
| reg-e-mail-dup ✅ | /reg/emaildup | post | e-mail 중복 검사 |
| reg-id-dup ✅ | /reg/iddup | post | 아이디 중복 검사 |
-
req
상세 정보
{ "id": "id", "pass": "pass" } -
res
상세 정보
- state 200
- 미정
- state 400
{ "result": false, "message": "Login Fail" }
- state 200
-
req
상세 정보
-
res
상세 정보
-
req
상세 정보
{ "email" : "email" } -
res
상세 정보
- state 200
{ "result" : true, "message" : "Find Id Success" } - state 400
{ "result" : false, "message" : "Find Id Fail" }
- state 200
-
req
상세 정보
{ "id" : "id", "email" : "email" } -
res
상세 정보
- state 200
{ "result" : true, "message" : "Find Pass Success" } - state 400
{ "result" : false, "message" : "Find Pass Fail" }
- state 200
-
req
상세 정보
-
res
상세 정보
-
req
상세 정보
{ "name" : "name", "id" : "id", "pass" : "pass", "email" : "email" } -
res
상세 정보
- state 200
{ "result" : true, "message" : "Sign up Success" } - state 400
{ "result" : false, "message" : "Sign up Fail" }
- state 200
-
req
- none
-
res
상세 정보
- state 200
{ "result" : true, "message" : "Email Authentication Success" } - state 400
{ "result" : false, "message" : "Email Authentication Fail" }
- state 200
-
req
상세 정보
{ "email" : "email" } -
res
상세 정보
- state 200
{ "result" : true, "message" : "Pass Email Check" } - state 400
{ "result" : false, "message" : "This Email already exists" }
- state 200
-
req
상세 정보
{ "name" : "name" } -
res
상세 정보
- state 200
{ "result" : true, "message" : "Pass Name Check" } - state 400
{ "result" : false, "message" : "This Name already exists" }
- state 200
-
req
상세 정보
{ "id" : "id" } -
res
상세 정보
- state 200
{ "result" : true, "message" : "Pass Id Check" } - state 400
{ "result" : false, "message" : "This Id already exists" }
- state 200
| API Path | Method | 설명 | |
|---|---|---|---|
| get-note | /note/getnote | get | 내 노트 가져오기 |
| get-share-note | /note/getsharenote | get | 공유노트 가져오기 |
| create-mynote | /mynote/create | post | 노트 생성 |
| update-mynote | /mynote/update | patch | 노트 수정 |
| delete-mynote | /mynote/delete | delete | 노트 삭제 |
-
req
- none
-
res
상세 정보
- state 200
{ "result" : true, "message" : "Get Note Success", "note":{ "idx":"idx", "userIdx":"userIdx", "context":"context", "category": { "name":"name" }, "isPublic":"isPublic", "template": { "name":"name", "template_context":"template_context", }, "path":"path", "parentFolderId":"parentFolderId", "update_at":"update_at", "create_at":"create_at" } } - state 400
{ "result" : false, "message" : "Get Note Fail" }
- state 200
-
req
- none
-
res
상세 정보
- state 200
{ "result" : true, "message" : "Get Note Success", "note":{ "idx":"idx", "userIdx":"userIdx", "context":"context", "category": { "name":"name" }, "isPublic":"isPublic", "template": { "name":"name", "template_context":"template_context" }, "path":"path", "parentFolderId":"parentFolderId", "update_at":"update_at", "create_at":"create_at" } } - state 400
{ "result" : false, "message" : "Get Note Fail" }
- state 200
-
req
상세 정보
{ "noteContext" : "noteContext", "category" : "category", "isPublic" : "isPublic", "template" : "template", "path" : "path", "parentFolderId" : "parentFolderId" } -
res
상세 정보
-
state 200
{ "result": true, "message": "Create Success" } -
state 400
{ "result": false, "message": "Create Fail" }
-
-
req
상세 정보
(수정 정보만 보내기) { "noteIdx" : "noteIdx", "noteContext" : "noteContext", "category" : "category", "isPublic" : "isPublic", "template" : "template", "path" : "path", "parentFolderId" : "parentFolderId" }
-
res
상세 정보
-
state 200
{ "result": true, "message": "Update Success" } -
state 400
{ "result": false, "message": "Update Fail" }
-
-
req
상세 정보
{ "noteIdx":"noteIdx" } -
res
상세 정보
-
state 200
{ "result": true, "message": "Delete Success" } -
state 400
{ "result": false, "message": "Delete Fail" }
-
| API Path | Method | 설명 | |
|---|---|---|---|
| create-folder | /folder | post | 폴더 생성하기 |
| read-folder | /folder | get | 폴더 읽어오기 (기준 폴더 하위 정보) |
| update-folder | /folder | patch | 폴더 수정하기 |
| delete-folder | /folder | get | 폴더 삭제하기 |
-
req
상세 정보
{ "name":"name", "path": "path", "parent_folder_idx" : "parent_folder_idx" } -
res
상세 정보
- state 200
{ "result": true, "message": "Folder Create Success" } - state 400
{ "result" : false, "message": "Folder Create Fail" }
- state 200
-
req
상세 정보
{ "folderIdx" : "folderIdx" } -
res
상세 정보
- state 200
{ "result" : true, "message" : "Read Success", "folders":[ {folder 객체} ], "notes":[ {note 객체} ] } - state 400
{ "result" : false, "message": "Read Fail" }
- state 200
-
req
상세 정보
{ "name":"name", "path": "path", "parent_folder_idx" : "parent_folder_idx" } -
res
상세 정보
- state 200
{ "result": true, "message": "Folder Update Success" } - state 400
{ "result" : false, "message": "Folder Update Fail" }
- state 200
-
req
상세 정보
{ "folderIdx": "folderIdx" } -
res
상세 정보
- state 200
{ "result" : true, "message" : "Delete Success" } - state 400
{ "message": "Folder Delete Fail" }
- state 200