Struttura dell'API REST per richiedere più articoli

Question

Struttura dell'API REST per richiedere più articoli

#1 da (3 voti)
#2 da (1 voti)

3

Ho un'API REST che assomiglia a qualcosa di simile al seguente in cui una persona può appartenere a un'organizzazione (ma non deve) e una persona ha molti elementi. Gli oggetti possono anche appartenere all'organizzazione al posto della persona.

/people/:personId
/people/:personId/items
/organisations/:orgId/items
/organisations/:orgId/people/:personId/items

C'è uno scenario in cui vogliamo interrogare gli articoli per più persone all'interno di un'organizzazione, qual è la struttura URL corretta da utilizzare?

Opzione 1

/organisations/:orgId/people/items?personId=1&personId=2

Opzione 2

/organisations/:orgId/items?personId=1&personId=2

Opzione 3

/items?personId=1&personId=2

api-design api rest

posta Jamie 24.06.2014 - 15:00

fonte

2 risposte

Leggi altre domande sui tag api-design api rest

Modifica dei sistemi di coordinate in python Design: Bridge Game [duplicato]

score 3 · Answer 1

Non importa molto. Il tuo URL è solo un 'unico strumento di ricerca delle risorse' il formato che utilizzi dipende da te. Vai con ciò che ti è più comodo e i tuoi utenti capiranno.

Detto questo, andrei con ?personId=1&personid=2 solo perché è facile da analizzare / leggere

dai un'occhiata a questo simile domanda

score 1 · Answer 2

Vorrei fare qualcosa di simile a come Microsoft si occupa della scelta delle pagine da stampare. Un esempio di questo è:

Per mostrare l'utente 3

...?show=3

Per mostrare tutti gli utenti da 10 a 50

...?show=10-50

Per mostrare all'utente 1 to 3 e 5 e 10 to 20

...?show=1-3,5,10-20

Offre completa libertà e può essere sviluppato abbastanza facilmente.