JNU-econovation / jnu-wiki-be

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

문서 기본정보 수정 요청 작성 API SPEC #103

Open pyg410 opened 1 year ago

pyg410 commented 1 year ago

문서 수정 요청 작성 API SPEC

Request

HTTP Method URI
POST /requests/update
Name Value Description
Authorization JWT 발급된 JWT
{
    "docsId" : 1,
    "docsRequestType" : "MODIFIED"
    "docsRequestCategory" : "CAFE",
    "docsRequestName" : "팬도로시",
    "docsRequestLocation" : "좌표",
 }

Response

Success

Name Value
content-type application/json
{
    "success" : "true",
    "response" : {
        "message" : "요청이 저장되었습니다."
    },
    "error": null
}

Fail

Status Description
400 BAD_REQUEST 잘못된 요청
401 UNAUTHORIZED 인증 실패
403 FORBIDDEN 권한 없음
500 Internal Server Error unknown server error

401 UNAUTHORIZED

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

403 FORBIDDEN

//Request Worn Field
{
    "success" : "false",
    "response" : null,
    "error": {
        "code" : 403
        "message" : "회원가입 후 15일이 지난 회원만 요청이 가능합니다.",
    }
}

404 NOT_FOUND

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