2023.09.05

์ƒ์„ฑ์ผ
Sep 4, 2023
ํƒœ๊ทธ
Server
์š”์ฒญ ์„ฑ๊ณต ์‹œ ๋ฉ”์‹œ์ง€ code ๋ณ€๊ฒฝ
// Beford
{
    "code": 1000,
    "message": "์š”์ฒญ์— ์„ฑ๊ณตํ•˜์˜€์Šต๋‹ˆ๋‹ค."
}

// After
{
    "code": 200,
    "message": "์š”์ฒญ์— ์„ฑ๊ณตํ•˜์˜€์Šต๋‹ˆ๋‹ค."
}
Exception ๋ฉ”์‹œ์ง€ ํ˜•์‹ ๋ณ€๊ฒฝ
// Before
{
    "status": 404,
    "code": "NOT_FOUND_DIARY",
    "message": "์ผ๊ธฐ๋ฅผ ์ฐพ์„ ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค."
}

// After
{
    "code": "NOT_FOUND_DIARY",
    "message": "์ผ๊ธฐ๋ฅผ ์ฐพ์„ ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค."
}
์ž์ฒด ๋กœ๊ทธ์ธ response ๊ตฌ์กฐ ๋ณ€๊ฒฝ
  • tokenResponse ์ถ”๊ฐ€ โ†’ depth ์ฆ๊ฐ€
{
    "code": 200,
    "message": "์š”์ฒญ์— ์„ฑ๊ณตํ•˜์˜€์Šต๋‹ˆ๋‹ค.",
    "result": {
        "tokenResponse": {
            "grantType": "Bearer ",
            "accessToken": "eyJhbGciOiJIUzUxMiJ9.eyJ1c2VySWQiOjYsImVtYWlsIjoidGVzdEBnbWFpbC5jb20iLCJpYXQiOjE2OTM4NDI5NjcsImV4cCI6MjE3NzI5NjkzODQyOTY3fQ.yyRf-TKXwKuFfFLBIyk2nFotkoEcxY0KKllMSPjxhY-8RUpKMSZDUqr3UMD5K2SIC9bI13VdrqZ5qfvSgGAjBQ",
            "refreshToken": "eyJhbGciOiJIUzUxMiJ9.eyJ1c2VySWQiOjYsImVtYWlsIjoidGVzdEBnbWFpbC5jb20iLCJpYXQiOjE2OTM4NDI5NjcsImV4cCI6MjE3NzI5NjkzODQyOTY3fQ.yyRf-TKXwKuFfFLBIyk2nFotkoEcxY0KKllMSPjxhY-8RUpKMSZDUqr3UMD5K2SIC9bI13VdrqZ5qfvSgGAjBQ",
            "accessTokenExpiresIn": 217729693842967
        },
        "userId": 6
    }
}
Comment API Base URL ๋ณ€๊ฒฝ
  • /api/v1/comments
ํ‘ธ์‹œ ์•Œ๋ฆผ ํƒ€์ž… ๋ณ€๊ฒฝ
  • pushAgree โ†’ boolean
  • ๊ธฐ์กด char
ํšŒ์›๊ฐ€์ž…
{
    "email": "test@gmail.com",
    "password": "test1234!",
    "checkPassword": "test1234!",
    "loginType": "EMAIL",
    "isPushAgree": true,
    "deviceToken": "test_deviceToken"
}
  • pushAgree๊ฐ€ boolean ๊ฐ’์ž„
๋กœ๊ทธ์ธ
  • ์ด๋ฉ”์ผ or ๋น„๋ฐ€๋ฒˆํ˜ธ ํ‹€๋ ธ์„ ๋•Œ ๋‚ด๋ ค ์ฃผ๋Š” Exception ํ•˜๋‚˜๋กœ ํ†ต์ผ
{
    "code": "INVALID_EMAIL_OR_PASSWORD",
    "message": "์ด๋ฉ”์ผ์ด๋‚˜ ๋น„๋ฐ€๋ฒˆํ˜ธ๊ฐ€ ์ผ์น˜ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค"
}
์ด์Šˆ
  • ์†Œ์…œ ๋กœ๊ทธ์ธ โ†’ ์—ฐ๋™ ํ…Œ์ŠคํŠธ ์ง„ํ–‰ํ•ด ๋ด์•ผ ๋จ
  • Push ๋˜ํ•œ ๋™์ž‘ ํ…Œ์ŠคํŠธ ์ง„ํ–‰ํ•ด ๋ด์•ผ ๋จ
ย 

2023.09.05

์ƒ์„ฑ์ผ
Sep 4, 2023
ํƒœ๊ทธ
Server
์š”์ฒญ ์„ฑ๊ณต ์‹œ ๋ฉ”์‹œ์ง€ code ๋ณ€๊ฒฝ
// Beford
{
    "code": 1000,
    "message": "์š”์ฒญ์— ์„ฑ๊ณตํ•˜์˜€์Šต๋‹ˆ๋‹ค."
}

// After
{
    "code": 200,
    "message": "์š”์ฒญ์— ์„ฑ๊ณตํ•˜์˜€์Šต๋‹ˆ๋‹ค."
}
Exception ๋ฉ”์‹œ์ง€ ํ˜•์‹ ๋ณ€๊ฒฝ
// Before
{
    "status": 404,
    "code": "NOT_FOUND_DIARY",
    "message": "์ผ๊ธฐ๋ฅผ ์ฐพ์„ ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค."
}

// After
{
    "code": "NOT_FOUND_DIARY",
    "message": "์ผ๊ธฐ๋ฅผ ์ฐพ์„ ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค."
}
์ž์ฒด ๋กœ๊ทธ์ธ response ๊ตฌ์กฐ ๋ณ€๊ฒฝ
  • tokenResponse ์ถ”๊ฐ€ โ†’ depth ์ฆ๊ฐ€
{
    "code": 200,
    "message": "์š”์ฒญ์— ์„ฑ๊ณตํ•˜์˜€์Šต๋‹ˆ๋‹ค.",
    "result": {
        "tokenResponse": {
            "grantType": "Bearer ",
            "accessToken": "eyJhbGciOiJIUzUxMiJ9.eyJ1c2VySWQiOjYsImVtYWlsIjoidGVzdEBnbWFpbC5jb20iLCJpYXQiOjE2OTM4NDI5NjcsImV4cCI6MjE3NzI5NjkzODQyOTY3fQ.yyRf-TKXwKuFfFLBIyk2nFotkoEcxY0KKllMSPjxhY-8RUpKMSZDUqr3UMD5K2SIC9bI13VdrqZ5qfvSgGAjBQ",
            "refreshToken": "eyJhbGciOiJIUzUxMiJ9.eyJ1c2VySWQiOjYsImVtYWlsIjoidGVzdEBnbWFpbC5jb20iLCJpYXQiOjE2OTM4NDI5NjcsImV4cCI6MjE3NzI5NjkzODQyOTY3fQ.yyRf-TKXwKuFfFLBIyk2nFotkoEcxY0KKllMSPjxhY-8RUpKMSZDUqr3UMD5K2SIC9bI13VdrqZ5qfvSgGAjBQ",
            "accessTokenExpiresIn": 217729693842967
        },
        "userId": 6
    }
}
Comment API Base URL ๋ณ€๊ฒฝ
  • /api/v1/comments
ํ‘ธ์‹œ ์•Œ๋ฆผ ํƒ€์ž… ๋ณ€๊ฒฝ
  • pushAgree โ†’ boolean
  • ๊ธฐ์กด char
ํšŒ์›๊ฐ€์ž…
{
    "email": "test@gmail.com",
    "password": "test1234!",
    "checkPassword": "test1234!",
    "loginType": "EMAIL",
    "isPushAgree": true,
    "deviceToken": "test_deviceToken"
}
  • pushAgree๊ฐ€ boolean ๊ฐ’์ž„
๋กœ๊ทธ์ธ
  • ์ด๋ฉ”์ผ or ๋น„๋ฐ€๋ฒˆํ˜ธ ํ‹€๋ ธ์„ ๋•Œ ๋‚ด๋ ค ์ฃผ๋Š” Exception ํ•˜๋‚˜๋กœ ํ†ต์ผ
{
    "code": "INVALID_EMAIL_OR_PASSWORD",
    "message": "์ด๋ฉ”์ผ์ด๋‚˜ ๋น„๋ฐ€๋ฒˆํ˜ธ๊ฐ€ ์ผ์น˜ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค"
}
์ด์Šˆ
  • ์†Œ์…œ ๋กœ๊ทธ์ธ โ†’ ์—ฐ๋™ ํ…Œ์ŠคํŠธ ์ง„ํ–‰ํ•ด ๋ด์•ผ ๋จ
  • Push ๋˜ํ•œ ๋™์ž‘ ํ…Œ์ŠคํŠธ ์ง„ํ–‰ํ•ด ๋ด์•ผ ๋จ
ย