Come gestire l'impaginazione nelle API REST?

La gestione dell'impaginazione nelle API REST è un aspetto cruciale della progettazione delle API, soprattutto per un fornitore di API come noi. Pagination ci consente di gestire in modo efficace set di dati di grandi dimensioni, migliorando le prestazioni e l'esperienza dell'utente. In questo blog esploreremo varie tecniche per gestire l'impaginazione nelle API REST, ne discuteremo i pro e i contro e forniremo esempi pratici.

Perché è necessaria la paginazione

Quando si ha a che fare con set di dati di grandi dimensioni, restituire tutti i dati in un'unica risposta può essere inefficiente e dispendioso in termini di risorse. Ciò può comportare tempi di risposta lunghi, un utilizzo elevato della memoria sia sul lato server che sul lato client e una potenziale congestione della rete. Pagination risolve questi problemi dividendo il set di dati in "pagine" più piccole e più gestibili e restituendo una pagina alla volta.

Tecniche comuni di impaginazione

Offset - Limita impaginazione

Offset: l'impaginazione limitata è una delle tecniche più semplici e comunemente utilizzate. Si tratta di specificare due parametri:offsetElimite. ILoffsetindica la posizione iniziale dei dati da recuperare e il filelimitespecifica il numero massimo di elementi da restituire nella risposta.

Ad esempio, se abbiamo un endpoint API/api/prodottiche restituisce un elenco di prodotti, una richiesta conscostamento = 20Elimite = 10restituirebbe i prodotti dal 21esimo al 30esimo.

Quello che segue è un esempio di Python Flask di implementazione dell'offset - limite di impaginazione:

from flask import Flask, request, jsonify app = Flask(__name__) prodotti = [{"id": i, "name": f"Prodotto {i}"} for i in range(100)] @app.route('/api/products', metodi=['GET']) def get_products(): offset = int(request.args.get('offset', 0)) limit = int(request.args.get('limit', 10)) paginated_products = prodotti[offset:offset + limite] return jsonify(paginated_products) if __name__ == '__main__': app.run(debug=True)

Pro:

• Facile da comprendere e implementare.
• Funziona bene con i database che supportanoLIMITEEOFFSETclausole, come MySQL e PostgreSQL.

Contro:

• Come iloffsetvalore aumenta, le prestazioni possono peggiorare in modo significativo, soprattutto per set di dati di grandi dimensioni. Questo perché il database deve ignorare un numero elevato di righe per raggiungere l'offset desiderato.
• Può essere difficile gestire i dati aggiornati durante l'impaginazione, poiché l'offset potrebbe non puntare più alla posizione corretta.

Impaginazione basata sul cursore

L'impaginazione basata sul cursore utilizza un identificatore univoco (il cursore) per contrassegnare la posizione nel set di dati. Invece di specificare un offset, il client fornisce il valore del cursore nella richiesta per ottenere la pagina di dati successiva.

Ad esempio, se abbiamo un elenco di utenti ordinati in base alla data di creazione, il cursore potrebbe essere la data di creazione dell'ultimo utente nella pagina precedente. Il server restituirebbe quindi il successivo set di utenti con una data di creazione maggiore del valore del cursore.

Ecco un semplice esempio JavaScript che utilizza Node.js ed Express:

const espresso = require('espresso'); const app = express(); const users = [ { id: 1, nome: 'Utente 1', creato_at: '2023-01-01' }, { id: 2, nome: 'Utente 2', creato_at: '2023-01-02' }, // più utenti... ]; app.get('/api/users', (req, res) => { const cursore = req.query.cursor; const limit = parseInt(req.query.limit) || 10; let startIndex = 0; if (cursor) { startIndex = users.findIndex(user => user.created_at > cursore); } const paginatedUsers = users.slice(startIndex, startIndex + limit); const nextCursor = paginatedUsers.length > 0 ? paginatedUsers[paginatedUsers.length - 1].created_at: null res.json({ utenti: paginatedUsers, next_cursor: nextCursor }); app.listen(3000, () => { console.log('Server in esecuzione sulla porta 3000'); });

Pro:

• Prestazioni migliori rispetto all'offset: limita l'impaginazione, soprattutto per set di dati di grandi dimensioni. Non è necessario che il database salti un numero elevato di righe.
• Più robusto quando si gestiscono aggiornamenti di dati, poiché il cursore punta sempre a una posizione specifica nel set di dati.

Contro:

• Più complesso da implementare, soprattutto quando si ha a che fare con più criteri di ordinamento.
• Richiede un identificatore univoco e ordinabile da utilizzare come cursore.

Impaginazione del numero di pagina

L'impaginazione del numero di pagina è simile all'offset: limita l'impaginazione, ma invece di specificare un offset, il client richiede un numero di pagina specifico. Il server calcola l'offset in base al numero di pagina e al limite.

Ad esempio, se il limite è di 10 elementi per pagina, una richiesta per la pagina 3 avrebbe un offset di 20 (poichéoffset = (numero_pagina - 1) * limite).

from flask import Flask, request, jsonify app = Flask(__name__) prodotti = [{"id": i, "name": f"Prodotto {i}"} for i in range(100)] @app.route('/api/products', metodi=['GET']) def get_products(): page = int(request.args.get('page', 1)) limit = int(request.args.get('limit', 10)) offset = (pagina - 1) * limit paginated_products = prodotti[offset:offset + limit] return jsonify(paginated_products) if __name__ == '__main__': app.run(debug=True)

Pro:

• Facile da comprendere per gli utenti, poiché è simile all'impaginazione tradizionale nelle pagine web.
• Semplice da implementare.

Contro:

• Similmente all'offset - limite di paginazione, può soffrire di problemi di prestazioni all'aumentare del numero di pagine.
• Può essere difficile gestire gli aggiornamenti dei dati durante l'impaginazione.

Considerazioni per i provider API

Come fornitore di API, dobbiamo considerare diversi fattori quando implementiamo l'impaginazione:

Standardizzazione

Dovremmo seguire le pratiche standard del settore per l'impaginazione. Ciò include l'utilizzo di nomi di parametri coerenti (comeoffset,limite,pagina,cursore) e fornendo una documentazione chiara su come funziona l'impaginazione.

Metadati

Oltre ai dati impaginati, dovremmo fornire metadati nella risposta, come il numero totale di elementi, il numero totale di pagine e i collegamenti alla pagina successiva e precedente. Ciò aiuta il cliente a comprendere meglio il set di dati e a navigare tra le pagine.

Ad esempio, la risposta potrebbe essere nel seguente formato:

{ "data": [ { "id": 1, "name": "Prodotto 1" }, { "id": 2, "name": "Prodotto 2" } ], "total_items": 100, "total_pages": 10, "next_page": "/api/products?offset=20&limit=10", "prev_page": null }

Sicurezza

Dobbiamo garantire che i parametri di impaginazione siano adeguatamente convalidati per prevenire l'iniezione SQL o altre vulnerabilità della sicurezza. Ad esempio, dovremmo convertire il fileoffsetElimiteparametri a numeri interi e impostare limiti ragionevoli per prevenire un consumo eccessivo di risorse.

Conclusione

La gestione dell'impaginazione nelle API REST è una competenza importante per i fornitori di API. Scegliendo la giusta tecnica di impaginazione in base alle dimensioni del set di dati, ai requisiti di prestazioni e all'esperienza dell'utente, possiamo fornire un'API più efficiente e facile da usare. Che tu abbia a che fare con un set di dati di piccole dimensioni o con un'applicazione su larga scala, è essenziale comprendere i pro e i contro dei diversi metodi di impaginazione.

Se sei interessato alle nostre API o hai domande sull'impaginazione o su altri argomenti relativi alle API, non esitare a contattarci per l'approvvigionamento e ulteriori discussioni. Offriamo anche una vasta gamma di prodotti comeMetocarbamolo,Azasetron cloridrato, EPirazinamide.

Riferimenti

• Richardson, Leonard e Sam Ruby. Servizi Web RESTful. O'Reilly Media, 2007.
• Banche, Adamo. Creazione di API Web RESTful con Python e Flask. Packt Publishing, 2018.