Un'API RESTful dovrebbe essere in grado di restituire file o solo una posizione

Question

Un'API RESTful dovrebbe essere in grado di restituire file o solo una posizione

#1 da (14 voti)
#2 da (7 voti)

8

Questo mi ha lasciato perplesso per un po '.

Ad esempio, abbiamo un'API REST che fornisce il contenuto di base a un sistema, consumando e producendo JSON. A questo punto finale produce un URL per un'immagine e una descrizione e si trova così: // localhost / myApi / pictures / 1

{
    id: 1,
    description: "This is a pretty picture of a daisy",
    URL: <OUR URL>
}

Ora OUR_URL dovrebbe puntare a una posizione sull'API, ad esempio // localhost / myApi / files / pictures / 1 che restituisce un JPG (l'applicazione dietro l'API legge il contenuto fisico del file e quindi lo ritorna indietro al cliente). Questo è ovviamente diverso dal resto dell'API che sta producendo le risposte JSON e ci sarà un sovraccarico dalla lettura e dallo streaming del file reale.

In alternativa, OUR_URL punta a un URL esterno all'ambito del servizio REST, quindi //localhost/files/pictures/1.jpg dove legge direttamente il file.

Quindi la domanda è:

Un'API RESTful dovrebbe essere in grado di restituire file o solo una posizione?

rest patterns-and-practices

posta Crazy Dino 31.12.2015 - 16:28

fonte

2 risposte

7

Un problema che si ha nel restituire gli URI è che un semplice vecchio file server non può fare la sicurezza. Quindi, se devi fare qualche tipo di limitazione su chi può accedere a un file, allora avrai bisogno di essere in grado di restituirlo direttamente nell'API REST (o no, se l'utente non ha diritti, il file è non nello stato corretto, ecc.).

Altrimenti, restituire il semplice vecchio URI e lasciarlo andare su un CDN dedicato ha molti vantaggi in termini di provisioning, semplicità e scalabilità - presupponendo che sia tutto ciò che devi fare.

risposta data 31.12.2015 - 16:54

fonte

Leggi altre domande sui tag rest patterns-and-practices

Quando usi l'ereditarietà per riutilizzare il codice, trovi troppo complicato che ingoia i vantaggi del riutilizzo? Come evitare che le modifiche a un'API interna interrompano altri progetti?

score 14 · Accepted Answer

Un servizio RESTful dovrebbe fornire risorse agli utenti dell'API. Le risorse possono avere vari formati, che vanno da JSON o XML a JPEG e HTML.

Non c'è nemmeno un requisito, o addirittura un'aspettativa, che una singola API serva solo risorse di un singolo formato. Non c'è niente di sbagliato nel pubblicare un documento JSON sull'URI /myApi/pictures/1 e un file JPEG dall'URI /myApi/files/pictures/1 .
In un caso più estremo, è anche possibile pubblicare sia la descrizione JSON che il file JPEG dallo stesso URL, a seconda del formato richiesto dal richiedente.