ID/PW를 통해 accessToken을 발급합니다.
-
Body Params
Key Type Example description required email stringexample@example.com 이메일 ✅ password stringpassword 비밀번호 ✅
// Example Response
{
"accessToken": "..."
}// Type
{
accessToken: string;
}새로운 계정을 생성합니다.
-
Body Params
Key Type Example description required email stringexample@example.com 이메일 ✅ password stringpassword 비밀번호 ✅ adminToken stringsecret_asdf .env파일의ADMIN_TOKEN값✅ 만약
.env파일에ADMIN_TOKEN의 값이 없을 경우, 계정 생성을 거부합니다.
별도의 응답 데이터가 없습니다.
계정을 삭제합니다.
-
Headers
Key Type Example description required authorization stringBearer 1234567890 POST /auth/login을 통해 발급받은 유효한 accessToken✅
별도의 응답 데이터가 없습니다.
특정 노션 페이지를 가져옵니다.
-
Query Params
Key Type Example description required pageId string63354a1852f04587a9f4d77ad2686d53 페이지의 노션 아이디 ❌ pageCode stringmain 미리 등록된 페이지 코드 ❌ domain stringindex 가져오고 싶은 페이지의 영역, 값이 없으면 index로 취급 ❌ pageId와pageCode가 모두 없는 경우400 WRONG_PARAMS오류를 반환합니다.pageId와pageCode가 모두 있는 경우pageId를 우선합니다.
// Example Response
{
"pageId": "63354a1852f04587a9f4d77ad2686d53",
"pageCode": "main",
"domain": "index",
"cachedAt": "2023-02-17T01:08:00",
"recordMap": { ... }
}// type
{
pageId: string;
pageCode: string | undefined;
domain: string;
cachedAt: string;
recordMap: { ... };
}모든 캐싱된 노션 페이지를 한 번에 50개씩 (env의 GET_PAGES_LIMIT 를 변경하여 수정 가능) 가져옵니다.
authorization 헤더를 통한 인증이 필요합니다.
-
Query Params
Key Type Example description required page number1 조회하고 싶은 페이지 ( 1부터 시작 ) ❌ -
Headers
Key Type Example description required authorization stringBearer 1234567890 POST /auth/login을 통해 발급받은 유효한 accessToken✅
// Example Response
{
"pages": [
{
"pageId": "63354a1852f04587a9f4d77ad2686d53",
"pageCode": "main",
"domain": "index",
"cachedAt": "2023-02-17T01:08:00",
"recordMap": { ... }
}, {
"pageId": "63354a1852f04587a9f4d77ad2686d53",
"pageCode": "main",
"domain": "index",
"cachedAt": "2023-02-17T01:08:00",
"recordMap": { ... }
},
...
],
"page": 1
}// Type
{
pages: {
pageId: string;
pageCode?: string;
domain: string;
cachedAt: string;
recordMap: { ... };
}[],
page: number
}특정 페이지를 수정합니다.
authorization 헤더를 통한 인증이 필요합니다.
-
Headers
Key Type Example description required authorization stringBearer 1234567890 POST /auth/login을 통해 발급받은 유효한 accessToken✅ -
Path Params
Key Type Example description required pageId number1 조회하고 싶은 페이지 ( 1부터 시작 ) ❌ -
Body Params
{ pageCode?: string; domain?: string; reCaching?: boolean; lazyReCaching?: boolean; }
Key Type Example description required pageCode stringmain ❌ domain stringindex ❌ reCaching booleantrue 기존 캐시를 삭제하고 새로 캐싱합니다. ❌ lazyReCaching booleantrue 기존 캐시를 삭제하고 다음 조회시에 캐싱합니다. ❌ reCaching과lazyReCaching이 모두true인 경우reCaching으로 동작합니다.
별도의 응답 데이터가 없습니다.
캐싱된 페이지의 정보를 삭제합니다.
authorization 헤더를 통한 인증이 필요합니다.
-
Headers
Key Type Example description required authorization stringBearer 1234567890 POST /auth/login을 통해 발급받은 유효한 accessToken✅ -
Path Params
Key Type Example description required pageId number1 조회하고 싶은 페이지 ( 1부터 시작 ) ❌
별도의 응답 데이터가 없습니다.