JNU-econovation / jnu-wiki-be

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

문서 리스트 API SPEC #98

Open pyg410 opened 11 months ago

pyg410 commented 11 months ago

문서 목록 조회 API SPEC

Request

HTTP Method URI
GET /docs
Name Type Description
 page Number(정수)   불러올 page(0부터 시작하며 응답의 totalPages가 n이라면 마지막 페이지는 n-1이 된다)
size Number(정수) 한 page당 받을 문서의 개수
rightLat Number(실수) 우측상단 위도
rightLng Number(실수) 우측상단 경도
leftLat Number(실수) 좌측하단 위도
leftLng Number(실수) 좌측하단 경도

Response

Success

Name Value Description
content-type application/json JSON

404 NOT_FOUND

//Request Worn Field
{
    "success" : false,
    "response" : null,
        "error": {
        "message":"문서 목록이 존재하지 않습니다.",
        "status":404
        }
}
jminkkk commented 11 months ago

?page={pageNum} 같이 조회 시 조건에 대한 내용이 추가해주시면 좋을 것 같습니다!!

참고로 저는 아래 멘트를 포함하여 작성을 했는데 이부분도 참고 해주시면 좋을 것 같습니당 이때 page는 0부터 시작하며 응답의 totalPages가 n이라면 마지막 페이지는 n-1이 된다.

pyg410 commented 11 months ago

수정했습니다! 예리한 피드백 감사합니다👍