JNU-econovation / jnu-wiki-be

전남대 학생들을 위한 전대위키 서비스
https://jnu-wiki.vercel.app/?_vercel_share=lgEftxL7mgkpGhyFMnkseGsYEgcflHVg
3 stars 2 forks source link

스크랩 등록 API SPEC #91

Open jminkkk opened 1 year ago

jminkkk commented 1 year ago

Request

HTTP Method URI
POST /scrap
Name Value Description
Authorization JWT 인증용 JWT
Name Value Description
content-type application/json  
{
  "success" : true,
  "response" : null
  "error": null
}

Fail

Status Description
400 BAD_REQUEST 잘 못 된 요청
401 UNAUTHORIZED 인증 실패
404 NOT_FOUND 문서 없음
500 Internal Server Error unknown server error

400 BAD_REQUEST

{
  "success" : false,
  "response" : null,
   "error": {
    "message": "잘못된 요청입니다.",
    "status": 400
  }
}

401 UNAUTHORIZED

{
  "success" : false,
  "response" : null,
   "error": {
    "message": "로그인이 필요한 기능입니다.",
    "status": 401
  }
}

404 NOT_FOUND

{
  "success" : false,
  "response" : null,
   "error": {
    "message": "존재하지 않는 문서입니다.",
    "status": 404
  }
}