Skip to content
mon823 edited this page Jun 18, 2021 · 4 revisions

목차

auth

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 아이디 중복 검사

login

  • req

    상세 정보
    {
        "id": "id",
        "pass": "pass"
    }
  • res

    상세 정보
    • state 200
      • 미정
    • state 400
      {
          "result": false,
          "message": "Login Fail"
      }

logout

  • req

    상세 정보
  • res

    상세 정보

id 찾기

  • req

    상세 정보
    {
        "email" : "email"
    }
  • res

    상세 정보
    • state 200
      {
          "result" : true,
          "message" : "Find Id Success"
      }
    • state 400
      {
          "result" : false,
          "message" : "Find Id Fail"
      }

pw 찾기

  • req

    상세 정보
    {
        "id" : "id",
        "email" : "email"
    }
  • res

    상세 정보
    • state 200
      {
          "result" : true,
          "message" : "Find Pass Success"
      }
    • state 400
      {
          "result" : false,
          "message" : "Find Pass Fail"
      }

pw 변경

  • 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"
      }

E-mail 인증

  • req

    • none
  • res

    상세 정보
    • state 200
      {
          "result" : true,
          "message" : "Email Authentication Success"
      }
    • state 400
      {
          "result" : false,
          "message" : "Email Authentication Fail"
      }

E-mail 메일 재전송...? 일단 두자 한번에 가라고 해 그냥 후..

E-mail 중복 검사

  • req

    상세 정보
    {
        "email" : "email"
    }
  • res

    상세 정보
    • state 200
      {
          "result" : true,
          "message" : "Pass Email Check"
      }
    • state 400
      {
          "result" : false,
          "message" : "This Email already exists"
      }

이름 중복 검사

  • req

    상세 정보
    {
        "name" : "name"
    }
  • res

    상세 정보
    • state 200
      {
          "result" : true,
          "message" : "Pass Name Check"
      }
    • state 400
      {
          "result" : false,
          "message" : "This Name already exists"
      }

아이디 중복 검사

  • req

    상세 정보
    {
        "id" : "id"
    }
  • res

    상세 정보
    • state 200
      {
          "result" : true,
          "message" : "Pass Id Check"
      }
    • state 400
      {
          "result" : false,
          "message" : "This Id already exists"
      }

note

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"
      }

공유 노트 가져오기

  • 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"
      }

노트 관리

노트 생성

  • 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"
      }

folder

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"
      }

폴더 읽기

  • req

    상세 정보
    {
        "folderIdx" : "folderIdx"
    }
  • res

    상세 정보
    • state 200
      {
          "result" : true,
          "message" : "Read Success",
          "folders":[
              {folder 객체}
          ],
          "notes":[
              {note 객체}
          ]
      }
    • state 400
      {
          "result" : false,
          "message": "Read Fail"
      }

폴더 수정

  • 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"
      }

폴더 삭제

  • req

    상세 정보
    {
        "folderIdx": "folderIdx"
    }
  • res

    상세 정보
    • state 200
      {
          "result" : true,
          "message" : "Delete Success"
      }
    • state 400
      {
          "message": "Folder Delete Fail"
      }

Documents

학습 사항

회의록

1주차

2주차

3주차

4주차

5주차

6주차

7주차

9주차

10주차

11주차

12주차

13주차

14주차

16주차

방학1주차

Clone this wiki locally