REST API에서 페이지 매기기를 처리하는 것은 특히 우리와 같은 API 제공업체의 경우 API 디자인의 중요한 측면입니다. 페이지 매김을 사용하면 대규모 데이터 세트를 효과적으로 관리하여 성능과 사용자 경험을 향상시킬 수 있습니다. 이 블로그에서는 REST API에서 페이지 매김을 처리하는 다양한 기술을 살펴보고 해당 기술의 장단점을 논의하고 실제 예제를 제공합니다.
페이지 매김이 필요한 이유
대규모 데이터 세트를 처리할 때 단일 응답으로 모든 데이터를 반환하는 것은 비효율적이고 리소스 집약적일 수 있습니다. 이로 인해 응답 시간이 길어지고 서버와 클라이언트 측 모두에서 높은 메모리 사용량이 발생하며 잠재적인 네트워크 정체가 발생할 수 있습니다. 페이지 매김은 데이터세트를 더 작고 관리하기 쉬운 "페이지"로 나누고 한 번에 한 페이지씩 반환함으로써 이러한 문제를 해결합니다.
일반적인 페이지 매김 기술
오프셋 - 페이지 매김 제한
오프셋 - 페이지 매김 제한은 가장 간단하고 일반적으로 사용되는 기술 중 하나입니다. 여기에는 두 가지 매개변수 지정이 포함됩니다.오프셋그리고한계. 그만큼오프셋검색할 데이터의 시작 위치를 나타냅니다.한계응답으로 반환할 최대 항목 수를 지정합니다.
예를 들어 API 엔드포인트가 있는 경우/api/제품제품 목록을 반환하는 요청은 다음과 같습니다.오프셋 = 20그리고한도 = 1021일부터 30일까지의 제품을 반환합니다.
다음은 오프셋 - 페이지 매김 제한을 구현하는 Python Flask 예입니다.
from 플라스크 가져오기 Flask, 요청, jsonify app = Flask(__name__) products = [{"id": i, "name": f"Product {i}"} for i in range(100)] @app.route('/api/products',method=['GET']) def get_products(): offset = int(request.args.get('offset', 0))limit = int(request.args.get('limit', 10)) paginated_products = products[offset:offset +limit] return jsonify(paginated_products) if __name__ == '__main__': app.run(debug=True)
장점:
- 이해하고 구현하기 쉽습니다.
- 다음을 지원하는 데이터베이스와 잘 작동합니다.
한계그리고오프셋MySQL 및 PostgreSQL과 같은 절.
단점:
- 다음과 같이
오프셋값이 증가하면 특히 대규모 데이터 세트의 경우 성능이 크게 저하될 수 있습니다. 이는 데이터베이스가 원하는 오프셋에 도달하기 위해 많은 수의 행을 건너뛰어야 하기 때문입니다. - 오프셋이 더 이상 올바른 위치를 가리키지 않을 수 있으므로 페이지 매김 중에 업데이트되는 데이터를 처리하기 어려울 수 있습니다.
커서 기반 페이지 매김
커서 기반 페이지 매김은 고유 식별자(커서)를 사용하여 데이터세트의 위치를 표시합니다. 클라이언트는 오프셋을 지정하는 대신 데이터의 다음 페이지를 가져오기 위해 요청에 커서 값을 제공합니다.
예를 들어 생성 날짜별로 정렬된 사용자 목록이 있는 경우 커서는 이전 페이지에서 마지막 사용자의 생성 날짜가 될 수 있습니다. 그런 다음 서버는 생성 날짜가 커서 값보다 큰 다음 사용자 집합을 반환합니다.
다음은 Node.js와 Express를 사용하는 간단한 JavaScript 예제입니다.
const 표현 = require('표현'); const 앱 = 표현(); const users = [ { id: 1, name: 'User 1', Created_at: '2023-01-01' }, { id: 2, name: 'User 2', Create_at: '2023-01-02' }, // 추가 사용자... ]; app.get('/api/users', (req, res) => { const 커서 = req.query.cursor; constlimit =parseInt(req.query.limit) || 10; let startIndex = 0; if (cursor) { startIndex = users.findIndex(user => user.created_at >cursor); } const paginatedUsers = users.slice(startIndex, startIndex + 제한); const nextCursor = paginatedUsers.length > 0 ? paginatedUsers[paginatedUsers.length - 1].created_at : null; res.json({ users: paginatedUsers, next_cursor: nextCursor }); app.listen(3000, () => { console.log('포트 3000에서 실행되는 서버'); });
장점:
- 오프셋에 비해 성능이 향상되었습니다. 특히 대규모 데이터세트의 경우 페이지 매김을 제한합니다. 데이터베이스에서 많은 수의 행을 건너뛸 필요가 없습니다.
- 커서가 항상 데이터 세트의 특정 위치를 가리키므로 데이터 업데이트를 처리할 때 더욱 강력해졌습니다.
단점:
- 특히 여러 정렬 기준을 처리할 때 구현이 더 복잡합니다.
- 커서로 사용하려면 고유하고 정렬 가능한 식별자가 필요합니다.
페이지 번호 페이지 매김
페이지 번호 페이지 매김은 오프셋 - 페이지 매김 제한과 유사하지만 오프셋을 지정하는 대신 클라이언트가 특정 페이지 번호를 요청합니다. 서버는 페이지 번호와 한도를 기준으로 오프셋을 계산합니다.
예를 들어 한도가 페이지당 10개 항목인 경우 3페이지에 대한 요청의 오프셋은 20입니다.오프셋 = (페이지_번호 - 1) * 제한).
플라스크 가져오기 Flask, 요청, jsonify app = Flask(__name__) products = [{"id": i, "name": f"Product {i}"} for i in range(100)] @app.route('/api/products',method=['GET']) def get_products(): page = int(request.args.get('page', 1))limit = int(request.args.get('limit', 10)) offset = (페이지 - 1) * 제한 paginated_products = products[offset:offset +limit] return jsonify(paginated_products) if __name__ == '__main__': app.run(debug=True)
장점:
- 웹페이지의 전통적인 페이지 매기기와 유사하므로 사용자가 이해하기 쉽습니다.
- 구현이 간단합니다.
단점:
- 오프셋 - 페이지 매김 제한과 마찬가지로 페이지 번호가 증가함에 따라 성능 문제가 발생할 수 있습니다.
- 페이지 매김 중에 데이터 업데이트를 처리하는 것이 어려울 수 있습니다.
API 제공자를 위한 고려 사항
API 제공자로서 페이지 매김을 구현할 때 다음과 같은 몇 가지 요소를 고려해야 합니다.
표준화
우리는 페이지 매김에 대한 업계 표준 관행을 따라야 합니다. 여기에는 일관된 매개변수 이름(예:오프셋,한계,페이지,커서), 페이지 매김 작동 방식에 대한 명확한 문서를 제공합니다.


메타데이터
페이지가 매겨진 데이터 외에도 총 항목 수, 총 페이지 수, 다음 및 이전 페이지 링크와 같은 메타데이터를 응답에 제공해야 합니다. 이는 클라이언트가 데이터 세트를 더 잘 이해하고 페이지를 탐색하는 데 도움이 됩니다.
예를 들어 응답은 다음 형식일 수 있습니다.
{ "data": [ { "id": 1, "name": "제품 1" }, { "id": 2, "name": "제품 2" } ], "total_items": 100, "total_pages": 10, "next_page": "/api/products?offset=20&limit=10", "prev_page": null }
보안
SQL 주입이나 기타 보안 취약점을 방지하려면 페이지 매김 매개변수의 유효성이 제대로 검증되었는지 확인해야 합니다. 예를 들어, 우리는오프셋그리고한계매개변수를 정수로 변환하고 과도한 리소스 소비를 방지하기 위해 합리적인 제한을 설정합니다.
결론
REST API에서 페이지 매김을 처리하는 것은 API 제공자에게 중요한 기술입니다. 데이터 세트 크기, 성능 요구 사항 및 사용자 경험을 기반으로 올바른 페이지 매김 기술을 선택함으로써 보다 효율적이고 사용자 친화적인 API를 제공할 수 있습니다. 소규모 데이터세트를 다루든 대규모 애플리케이션을 다루든, 다양한 페이지 매김 방법의 장단점을 이해하는 것이 필수적입니다.
API에 관심이 있거나 페이지 매김 또는 기타 API 관련 주제에 대해 질문이 있는 경우 조달 및 추가 논의를 위해 언제든지 문의해 주세요. 우리는 또한 다음과 같은 다양한 제품을 제공합니다.메토카바몰,아자세트론 염산염, 그리고피라진아마이드.
참고자료
- 리처드슨, 레너드, 샘 루비. RESTful 웹 서비스. 오라일리 미디어, 2007.
- 뱅크스, 아담. Python 및 Flask를 사용하여 RESTful 웹 API 구축. 팩트 출판, 2018.
