pagination | Notion

PrevNextPagination

default pagination 방식

item_total, page_total, current_page, page 를 이용해 NumberPagination 으로 사용 가능
parameters

key	type	description
item_total	int	총 data 개수 (모든 페이지)
page_total	int	총 page 수
current_page	int	현재 page
next_link	URL	다음 page를 불러올 수 있는 API link
prev_link	URL	이전 page를 불러올 수 있는 API link
first_link	URL	첫 page를 불러올 수 있는 API link

query parameters
- 공통 query parameter
- Pagination 을 지원하는 대부분의 API (link type) 에서 공통으로 사용할 수 있음

key	type	default	description
page_size	int	20	data를 몇 개씩 나눠서 pagination 할 지 정함 all 을 넣으면 한 page에 모든 데이터를 보내줌
page	int	1	몇 번째 page를 불러올지 정함
q	char		검색어 필터 (어떤 값을 검색할지는 API 별로 다를 수 있음

sort
- 기본 sort
  - 기본 sort이므로 대부분의 query param에서 지원하고 문서에 별도 표기하지 않음
  - latest
    - 최신 데이터가 먼저
    - sort parameter를 넣지 않을 때 기본으로 latest를 씀
  - earliest
    - 오래된 데이터가 먼저
- 그 외에 API 별로 각각 적용되는 sort가 있을 수 있음
  - i.e) name_dsc : 이름 내림차순, name_asc: 이름 오름차순
input sample
- GET /api/things/files/?page_size=2&page=1&q=shield&sort=earliest

output sample

{
    "pagination": {
        "item_total": 10,
        "page_total": 5,
        "current_page": 1,
        "next_link": "<http://localhost:8000/api/things/files/?page=2&page_size=2&q=shield&sort=earliest>",
        "prev_link": null,
        "first_link": null
    },
    "data": [
        {
            "id": 10,
            "file": "<http://localhost:8000/upload/files/shield_nlMSPfQ.png>",
            "filename": "shield.png",
            "content_type": "image/png",
            "size": 48248,
            "created_at": "2023-09-13T09:13:29+0900"
        },
        {
            "id": 9,
            "file": "<http://localhost:8000/upload/files/shield_rm2k1jP.png>",
            "filename": "shield.png",
            "content_type": "image/png",
            "size": 48248,
            "created_at": "2023-09-13T09:13:28+0900"
        }
    ]
}

filter

filter 의 항목들이 고정되어 있지 않고 database 기반으로 바뀔 경우 filter로 사용할 항목들을 같이 보내줌
- i.e) 현재 회원들의 지역 정보를 필터로 사용하고 싶을 경우
output sample
- 아래와 같은 filter를 받았을 경우 content_type filter는 “image/png”와 “image/gif” 두 개를 보여주면 됨

{
    "pagination": {
        "item_total": 10,
        "page_total": 5,
        "current_page": 1,
        "next_link": "<http://localhost:8000/api/things/files/?page=2&page_size=2&sort=earliest>",
        "prev_link": null,
        "first_link": null
    },
    "filter": {
        "content_type": [
            "image/png",
            "image/gif"
        ]
    },
    "data": [
        {
            "id": 10,
            "file": "<http://localhost:8000/upload/files/shield_nlMSPfQ.png>",
            "filename": "shield.png",
            "content_type": "image/png",
            "size": 48248,
            "created_at": "2023-09-13T09:13:29+0900"
        },
        {
            "id": 9,
            "file": "<http://localhost:8000/upload/files/shield_rm2k1jP.gif>",
            "filename": "shield.gif",
            "content_type": "image/gif",
            "size": 48248,
            "created_at": "2023-09-13T09:13:28+0900"
        }
    ]
}