Sto costruendo un api e un po 'nello sviluppo mi sono reso conto che cambio costantemente l'ordine dei parametri page e pageSize .
Attualmente uso C # e javascript, quindi la dichiarazione del metodo assomiglia a questo:
public IEnumerable<Order> Get(int pageSize = 9, int page = 1, string name = null)
E il codice cliente:
this.get = function (name, pageSize, page) {
// Do stuff..
}
Ma molte volte ho finito per scrivere:
name, page, pageSize // note that page is before pageSize.
E ha anche un endpoint http, che al momento assomiglia a questo (con pageSize prima):
www.example.org/api/orders/9/1
O dovrebbe apparire come questo (con pageSize last):
www.example.org/api/orders/1/9
Qual è il modo logico per chiamare un'api? Impostando prima page o pageSize prima? Esiste una pratica migliore (o comune)?
Argomento per impostare pageSize prima:
- Il consumatore può semplicemente definire il numero di elementi da recuperare senza impostare la pagina.
Argomento per impostare page prima:
- Il consumatore può semplicemente spostare la pagina e fare affidamento sui server pageSize.