Memos

Memo API 입니다.

메모 랜덤 조회

회원의 메모들 중 랜덤으로 하나를 반환한다.

GET https://SEOLLEM.link/memos/random

Content-Type : JSON

Headers

Name
Type
Description

Authorization*

String

Bearer JSON

Path
Type
Description
Not Null

memoId

long

메모 식별자 ID .

O

memoContent

String

메모 내용

O

memoType

String

메모 타입

O

memoBookPage

int

메모 연관 책 페이지

O

Example

[
    {
        "memoId": 25,
        "memoContent": "메모21 44",
        "memoType": "QUESTION",
        "memoBookPage": 55
    }
]

메모 등록

작성한 메모를 등록한다.

POST https://SEOLLEM.link/memos

Content-Type : JSON

Query Parameters

Name
Type
Description

bookId*

long

책 식별자 ID

Headers

Name
Type
Description

Authorization*

String

Bearer JWT

Request Body

Name
Type
Description

memoType

String

0=BOOK_CONTENT / 1=SUMMARY / 2=THOUGHT / 3=QUESTION * 비어 있을 시 기본값 0

memoBookPage*

int

메모 연관 책 페이지

memoContent*

String

메모 내용

memoAuthority

String

0=PRIVATE / 1=PUBLIC * 비어 있을 시 기본값 0

{
    "memoId": 17,
    "memoType": "BOOK_CONTENT",
    "memoContent": "메모 내용",
    "memoBookPage": 234,
    "memoAuthority": "PRIVATE",
    "memoLikesCount": 0,
    "createdAt": "2023-02-26T12:24:40.923768",
    "updatedAt": "2023-02-26T12:24:40.923768"
}

이미지 메모 등록

메모의 이미지를 등록한다.

POST https://SEOLLEM.link/memos/image-memo

Content-Type : form-data

Headers

Name
Type
Description

Authorization*

String

Bearer JWT

Request Body

Name
Type
Description

file*

file

이미지 파일

https://be-35-bucket.s3.ap-northeast-2.amazonaws.com/8a9bb291-3489-4e18-9df3-5ff360707087.jpeg

메모 수정

등록된 메모를 수정한다.

PATCH https://SEOLLEM.link/memos/{memo-id}

Content-Type : JSON

Path Parameters

Name
Type
Description

{memo-id}*

long

메모 식별자 ID

Headers

Name
Type
Description

Authorization*

String

Bearer JWT

Request Body

Name
Type
Description

memoType

String

0=BOOK_CONTENT / 1=SUMMARY / 2=THOUGHT / 3=QUESTION

memoBookPage

int

메모 연관 책 페이지

memoContent

String

메모 내용

memoAuthority

String

0=PRIVATE / 1=PUBLIC

{
    "memoId": 15,
    "memoType": "QUESTION",
    "memoContent": "hi",
    "memoBookPage": 0,
    "memoAuthority": "PUBLIC",
    "memoLikesCount": 0,
    "createdAt": "2023-02-26T12:23:32.97284",
    "updatedAt": "2023-02-26T12:30:28.101388"
}

메모 삭제

등록된 메모를 삭제한다.

DELETE https://SEOLLEM.link/memos/{memo-id}

Content-Type : JSON

Path Parameters

Name
Type
Description

{memo-id}*

long

메모 식별자 ID

Headers

Name
Type
Description

Authorization*

String

Bearer JWT

Last updated