JNU-econovation / jnu-wiki-be

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

관리자 새 문서 생성 요청 목록 조회 API SPEC #85

Open jminkkk opened 1 year ago

jminkkk commented 1 year ago

Request

HTTP Method URI
GET /admin/requests/new?page={pageNum}

이때 page는 0부터 시작하며 응답의 totalPages가 n이라면 마지막 페이지는 n-1이 된다.

Name Value Description
Authorization JWT 인증용 JWT

Response

Success

Name Value Description
content-type application/json  
{
    "success": true,
    "response": {
        "createdRequestList": [
            {
                "docsRequestId": 3,
                "docsRequestType": "CREATED",
                "docsRequestCategory": "카페",
                "docsRequestName": "요청문서33",
                "docsRequestLocation": {
                    "lat": 35.17641341218037,
                    "lng": 126.91349388159176
                }
            },
            {
                "docsRequestId": 2,
                "docsRequestType": "CREATED",
                "docsRequestCategory": "카페",
                "docsRequestName": "요청문서22",
                "docsRequestLocation": {
                    "lat": 35.17641341218037,
                    "lng": 126.91349388159176
                }
            },
            {
                "docsRequestId": 1,
                "docsRequestType": "CREATED",
                "docsRequestCategory": "카페",
                "docsRequestName": "요청문서11",
                "docsRequestLocation": {
                    "lat": 35.17641341218037,
                    "lng": 126.91349388159176
                }
            }
        ],
        "totalPages": 1
    },
    "error": null
}

Fail

Status Description
400 BAD_REQUEST 잘 못 된 요청
401 UNAUTHORIZED 인증 실패
403 FORBIDDEN 권한 없음
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
  }
}

403 FORBIDDEN

{
  "success" : false,
  "response" : null,
   "error": {
    "message": "관리자 권한이 없습니다.",
    "status": 403
  }
}

404 NOT_FOUND

{
  "success" : false,
  "response" : null,
   "error": {
    "message": "새 문서 요청이 존재하지 않습니다.",
    "status": 404
  }
}