API response 형태 정리

[Moon-ju-young]

API 명세서에서 보기 힘들어서 response들의 형태만 정리했습니다.
request body는 정리 안했습니다.

인증

POST /token

{
    "item": {
        "token": "string", // jwt 토큰 decode하면 payload에 userId 활용 가능 (참고)
        "user": {
            "item": {
                "id": "string",
                "email": "string",
                "type": "employer | employee",
                "name": "string", // optional
                "phone": "string", // optional
                "address": "string", // optional
                "bio": "string" // optional
            },
            "href": "string"
        }
    },
    "links": []
}

공고

GET /notices

{
    "offset": "number",
    "limit": "number",
    "count": "number", // 전체 개수
    "hasNext": "boolean", // 다음 내용 존재 여부
    "address": "string[]",
    "keyword": "string" // optional,
    "items": [
        {
            "item": {
                "id": "string",
                "hourlyPay": "number",
                "startsAt": "string",
                "workhour": "number",
                "description": "string",
                "closed": "boolean",
                "shop": {
                    "item": {
                        "id": "string",
                        "name": "string",
                        "category": "string",
                        "address1": "string",
                        "address2": "string",
                        "description": "string",
                        "imageUrl": "string",
                        "originalHourlyPay": "number"
                    },
                    "href": "string"
                }
            },
            "links": [...]
        }
    ],
    "links": [
        {
            "rel": "self",
            "description": "현재 페이지",
            "method": "GET",
            "href": "/api/0-1/the-julge/notices?offset=0&limit=10"
        },
        {
            "rel": "prev",
            "description": "이전 페이지",
            "method": "GET",
            "href": "/api/0-1/the-julge/notices?offset=0&limit=10"
        },
        {
            "rel": "next",
            "description": "다음 페이지",
            "method": "GET",
            "href": "/api/0-1/the-julge/notices?offset=10&limit=10"
        }
    ]
}

GET /shops/{shop_id}/notices

{
    "offset": "number",
    "limit": "number",
    "count": "number", // 전체 개수
    "hasNext": "boolean", // 다음 내용 존재 여부
    "items": [
        {
            "item": {
                "id": "string",
                "hourlyPay": "number",
                "startsAt": "string",
                "workhour": "number",
                "description": "string",
                "closed": "boolean",
            },
            "links": [...]
        }
    ],
    "links": [...]
}

POST /shops/{shop_id}/notices

하단의 PUT /shops/{shop_id}/notices/{notice_id} 와 동일

GET /shops/{shop_id}/notices/{notice_id}

{
    "item": {
        "id": "string",
        "hourlyPay": "number",
        "startsAt": "string",
        "workhour": "number",
        "description": "string",
        "closed": "boolean",
        "shop": {
            "item": {
                "id": "string",
                "name": "string",
                "category": "string",
                "address1": "string",
                "address2": "string",
                "description": "string",
                "imageUrl": "string",
                "originalHourlyPay": "number"
            },
            "href": "string"
        },
        "currentUserApplication": {
            "item": {
                "id": "string", // application.id,
                "status": "pending | accepted | rejected | canceled", // application.status
                createdAt: "string", // application.createdAt
            },
        },
    },
    "links": [...]
}

PUT /shops/{shop_id}/notices/{notice_id}

{
    "item": {
        "id": "string",
        "hourlyPay": "number",
        "startsAt": "string",
        "workhour": "number",
        "description": "string",
        "closed": "boolean",
        "shop": {
            "item": {
                "id": "string",
                "name": "string",
                "category": "string",
                "address1": "string",
                "address2": "string",
                "description": "string",
                "imageUrl": "string",
                "originalHourlyPay": "number"
            },
            "href": "string"
        }
    },
    "links": [...]
}

유저

POST /users

{
    "item": {
        "id": "string",
        "email": "string",
        "type": "employee | employer"
    },
    "links": [ ... ]
}

GET /users/{user_id}

아래와 동일

PUT /users/{user_id}

{
    "item": {
        "id": "string",
        "email": "string",
        "type": "employer | employee",
        "name": "string", // optional
        "phone": "string", // optional
        "address": "string", // optional
        "bio": "string", // optional
        "shop": {
            "item": {
                "id": "string",
                "name": "string",
                "category": "string",
                "address1": "string",
                "address2": "string",
                "description": "string",
                "imageUrl": "string",
                "originalHourlyPay": "number",
            }
        } // 또는 null
    },
    "links": [...]
}

가게

POST /shops

아래와 동일

GET /shops/{shop_id}

아래와 동일

PUT /shops/{shop_id}

{
    "item": {
        "id": "string",
        "name": "string",
        "category": "string",
        "address1": "string",
        "address2": "string",
        "description": "string",
        "imageUrl": "string",
        "originalHourlyPay": "number",
        "user": {
            "item": {
                "id": "string",
                "email": "string",
                "type": "employer | employee",
                "name": "string", // optional
                "phone": "string", // optional
                "address": "string", // optional
                "bio": "string", // optional
            },
            "href": "string"
        },
    },
    "links": [...]
}

지원

GET /shops/{shop_id}/notices/{notice_id}/applications

{
    "offset": "number",
    "limit": "number",
    "count": "number", // 전체 개수
    "hasNext": "boolean", // 다음 내용 존재 여부
    "items": [
        {
            "item": {
                "id": "string",
                "status": "pending | accepted | rejected | canceled",
                "createdAt": "string",
                "user": {
                    "item": {
                        "id": "string",
                        "email": "string",
                        "type": "employer | employee",
                        "name": "string", // optional
                        "phone": "string", // optional
                        "address": "string", // optional
                        "bio": "string", // optional
                    },
                    "href": "string"
                },
                "shop": {
                    "item": {
                        "id": "string",
                        "name": "string",
                        "category": "string",
                        "address1": "string",
                        "address2": "string",
                        "description": "string",
                        "imageUrl": "string",
                        "originalHourlyPay": "number"
                    },
                    "href": "string"
                }
                "notice": {
                    "item": {
                        "id": "string",
                        "hourlyPay": "number",
                        "description": "string",
                        "startsAt": "string",
                        "workhour": "number",
                        "closed": "boolean",
                    },
                    "href": "string"
                }
            },
            "links": [...]
        }
    ],
    "links": [...]
}

POST /shops/{shop_id}/notices/{notice_id}/applications

아래와 동일

PUT /shops/{shop_id}/notices/{notice_id}/applications/{application_id}

{
    "item": {
        "id": "string",
        "status": "pending | accepted | rejected | canceled",
        "createdAt": "string",
        "user": {
            "item": {
                "id": "string",
                "email": "string",
                "type": "employer | employee",
                "name": "string", // optional
                "phone": "string", // optional
                "address": "string", // optional
                "bio": "string", // optional
            },
            "href": "string"
        },
        "shop": {
            "item": {
                "id": "string",
                "name": "string",
                "category": "string",
                "address1": "string",
                "address2": "string",
                "description": "string",
                "imageUrl": "string",
                "originalHourlyPay": "number"
            },
            "href": "string"
        }
        "notice": {
            "item": {
                "id": "string",
                "hourlyPay": "number",
                "description": "string",
                "startsAt": "string",
                "workhour": "number",
                "closed": "boolean",
            },
            "href": "string"
        }
    },
    "links": [...]
}

GET /users/{user_id}/applications

{
    "offset": "number",
    "limit": "number",
    "count": "number", // 전체 개수
    "hasNext": "boolean", // 다음 내용 존재 여부
    "items": [
        {
            "item": {
                "id": "string",
                "status": "pending | accepted | rejected | canceled",
                "createdAt": "string",
                "shop": {
                    "item": {
                        "id": "string",
                        "name": "string",
                        "category": "string",
                        "address1": "string",
                        "address2": "string",
                        "description": "string",
                        "imageUrl": "string",
                        "originalHourlyPay": "number"
                    },
                    "href": "string"
                }
                "notice": {
                    "item": {
                        "id": "string",
                        "hourlyPay": "number",
                        "description": "string",
                        "startsAt": "string",
                        "workhour": "number",
                        "closed": "boolean",
                    }
                }
            },
            "links": [...]
        }
    ],
    "links": [...]
}

알림

GET /users/{user_id}/alerts

얘는 왜 배열 안에 property가 있는건지
아래와 유사

{
    "offset": "number",
    "limit": "number",
    "count": "number", // 전체 개수
    "hasNext": "boolean", // 다음 내용 존재 여부
    "items": [
        {
            "item": {
                "id": "string",
                "createdAt": "string",
                "result": "accepted" | "rejected",
                "read": "boolean",
                "application": {
                    "item": {
                        "id": "string",
                        "status": "pending | accepted | rejected",
                    },
                    "href": "string"
                },
                "shop": {
                    "item": {
                        "id": "string",
                        "name": "string",
                        "category": "string",
                        "address1": "string",
                        "address2": "string",
                        "description": "string",
                        "imageUrl": "string",
                        "originalHourlyPay": "number"
                    },
                    "href": "string"
                }
                "notice": {
                    "item": {
                        "id": "string",
                        "hourlyPay": "number",
                        "description": "string",
                        "startsAt": "string",
                        "workhour": "number",
                        "closed": "boolean",
                    }
                    "href": "string"
                }
                "links": [...]
            }
        },
        "links": [...]
    ]
}

PUT /users/{user_id}/alerts/{alert_id}

{
    "offset": "number",
    "limit": "number",
    "items": [
        {
            "item": {
                "id": "string",
                "createdAt": "string",
                "result": "accepted" | "rejected",
                "read": "boolean",
                "application": {
                    "item": {
                        "id": "string",
                        "status": "pending | accepted | rejected",
                    },
                    "href": "string"
                },
                "shop": {
                    "item": {
                        "id": "string",
                        "name": "string",
                        "category": "string",
                        "address1": "string",
                        "address2": "string",
                        "description": "string",
                        "imageUrl": "string",
                        "originalHourlyPay": "number"
                    },
                    "href": "string"
                }
                "notice": {
                    "item": {
                        "id": "string",
                        "hourlyPay": "number",
                        "description": "string",
                        "startsAt": "string",
                        "workhour": "number",
                        "closed": "boolean",
                    }
                    "href": "string"
                }
                "links": [...]
            }
        },
        "links": [...]
    ]
}

이미지 업로드

POST /images

{
    "item": {
        "url": "string" // Presigned URL
    },
    "links": [...]
}

[Moon-ju-young]

참고: https://www.notion.so/api-response-2101b530645e80af8cb8c65d3258f421