백엔드 프론트엔드 api 스펙 정의

[qlqhqo2341]

• 설계하면서 서로 필요한 API를 찾고 데이터 및 로직 흐름정리하기.

[qlqhqo2341]

코션 페이지 모델

{
    "id": "integer : 페이지 id",
    "owner" : "string : user id",
    "createdt" : "integer : unix timestamp in ms",
    "updatedt" : "integer : unix timestamp in ms",
    "blockList" : [
        {
            "":"코션 블록 모델"
        },
    ]
}

코션 블록 인터페이스 모델

{
    "id": "integer : 블록 id",
    "type": "string(enum) : block type",
    "options" : {
        "":"코션 블록 옵션"
    },
    "contents" : {
        "":"코션 블록 데이터"
    }
}

id는 블록 이하 생략

코션 플레인 텍스트 블록

{
    "type": "plain_text",
    "options" : {
        "font-size" : "int: ",
        "font-size-unit" : "string: px | em | rem",
        "font" : "string(enum): ?? ",
    },
    "contents" : {
        "text" : "string : 텍스트"
    }
}

코션 할일 블록

{
    "type": "todo",
    "options" : {},
    "contents" : {
        "components" : [
            {
                "finished" : "boolean : 완료 여부",
                "duedt" : "int: unix tiemstamp in ms",
                "text" : "텍스트"
            },
        ]
    }
}

코션 이미지 블록

{
    "type":"image",
    "options" : {},
    "contents" : {
        "width":"int",
        "height": "int",
        "size-unit" : "string(enum) : px | em | rem",
        "url": "string: image url"
    }
}

코션 캘린더 블록 (?)

{
    "type": "calendar",
    "options" : {},
    "contents" : {
        "schedules" : [
            {
                "title" : "string",
                "startdt" : "int : unix timestamp in ms",
                "enddt" : "int : unix timestamp in ms"
            },
        ]
    }
}

코션 페이지 API

리스트 조회

GET /api/page/list

request query param

• userId : string

response

{
    "success" : "boolean",
    "pageList" : [
        {
            "id": "int : 페이지 id"
        },
    ]
}

페이지 상세 조회

GET /api/page/{pageId}

request query param

• userId : string

response

{
    "succes" : "boolean",
    "page" : {
        "":"코션 페이지 모델"
    }
}

생성

POST /api/page

request body

{
    "userId" : "string",
    "page" : {
        "":"코션 페이지 모델, id 제외"
    }
}

response

{
    "success" : "boolean",
    "pageId" : "int : page id"
}

수정

PATCH /api/page/{id}

request body

{
    "userId" : "string",
    "page" : {
        "":"코션 페이지 모델, id 제외"
    }
}

response

{
    "success" : "boolean",
    "pageId" : "int : page id"
}

삭제

DELETE /api/page/{id}

request query param

• userId : string

response

{
    "success" : "boolean",
    "pageId" : "int : page id"
}