Quando usare l'impaginazione in API?

Sommario:

Quando usare l'impaginazione in API?
Quando usare l'impaginazione in API?
Anonim

L'impaginazione dell'API è essenziale se hai a che fare con molti dati ed endpoint. L'impaginazione implica automaticamente l'aggiunta di ordine al risultato della query. L'ID oggetto è il risultato predefinito, ma i risultati possono essere ordinati anche in altri modi.

Qual è lo scopo dell'impaginazione?

Pertanto, l'impaginazione agisce come un'interruzione di pagina, lasciando agli utenti la possibilità di considerare la mossa successiva e fornendo loro i mezzi per passare da un insieme di elementi all' altro. L'elenco dei numeri nel modello di impaginazione consente inoltre agli utenti di determinare quante altre pagine sono rimaste da esaminare.

Cos'è l'API REST di impaginazione?

Nel settore vengono utilizzati più nomi per gli endpoint che restituiscono un set impaginato, in particolare nelle API REST, come risorse di raccolta, elenchi di endpoint, endpoint di indicizzazione, ecc. … I lo chiamerò "elencare gli endpoint" in tutto il documento.

Che cos'è la risposta di impaginazione?

Impaginazione nell'API Square

Negli endpoint dell'API Square, i risultati impaginati includono un campo cursore come parte del corpo della risposta. Per recuperare la serie successiva di risultati, inviare una richiesta di follow-up allo stesso endpoint e fornire il valore del cursore restituito nella risposta precedente come parametro di query.

Come dovrebbe funzionare l'impaginazione?

Buone pratiche di progettazione dell'impaginazione

  1. Fornisci ampie aree cliccabili.
  2. Non usare sottolineature.
  3. Identifica la pagina corrente.
  4. Spazia la paginalink.
  5. Fornisci link precedente e successivo.
  6. Utilizza il primo e l'ultimo link (ove applicabile)
  7. Metti il primo e l'ultimo link all'esterno.

Consigliato: