Configurare percorsi REST in Express JS per Ajax da utilizzare solo con Backbone

Question

Sto lavorando alla riscrittura di un sito Web esistente utilizzando Node.js con Express.

Il front-end del sito utilizza Backbone JS e pertanto è necessario che tutti i percorsi necessari siano conformi alla sincronizzazione Backbone nativa. Ora la maggior parte degli URL è il client e la sincronizzazione Backbone sarà la stessa. Ma non funzioneranno per regolare GET in quanto avrebbero bisogno di restituire JSON.

Così sto pensando, sarebbe una buona idea di aggiungere l'estensione al modello URL/Collection in Backbone, come .json, e in veloce per avere questo per ogni percorso:

app.get('/p/:topCategory/:category/:product.:format', function(req, res) { ... }); 

Dove if (req.params.id == 'json') di inviamo JSON, altrimenti rendiamo HTML?

O c'è un approccio migliore? Per favore aiuto.

Answer 1

Il modo migliore per farlo sarebbe quello di utilizzare la funzione di negoziazione del contenuto in veloce 3.x, vale a dire res.format:

https://github.com/visionmedia/express/blob/master/lib/response.js#L299-378

res.format({ 
    text: function(){ 
    res.send('hey'); 
    }, 

    html: function(){ 
    res.send('<p>hey</p>'); 
    }, 

    json: function(){ 
    res.send({ message: 'hey' }); 
    } 
}); 

approccio Si è anche OK, Yammer per es. sta usando lo stesso approccio: http://developer.yammer.com/api/#message-viewing

Answer 2

Utilizzare le intestazioni Accept nelle richieste: Accept: application/json se si desidera ricevere JSON, Accept: text/HTML se si desidera l'HTML.

Answer 3

Un'alternativa che controlla anche che l'intestazione "X-Requested-With" sia impostata per jQuery et al.

var onlyAllowJsonRequests = function (req, res, next) { 

    var acceptJson = (req.accepted.length && _.any(req.accepted, function (acc) { return acc.value.indexOf("json") !== -1 })); 

    // also check that "X-Requested-With": "XMLHttpRequest" header is set 
    if (acceptJson && (req.xhr === true)) { 
     next(); 
    } else { 
     res.send(406, "Not Acceptable"); 
    } 
}; 

app.use(onlyAllowJsonRequests); 

NB Il carattere di sottolineatura è una depency.

Answer 4

Penso che il modo corretto per fare ciò sia implementare la negoziazione di contenuto nell'applicazione. Sì, Express 3.x è un modo per farlo e fornisce una risposta diretta alla tua domanda, ma non penso che sia il modo migliore per farlo perché pone la responsabilità della negoziazione del contenuto nella logica di routing. Non penso che sia un buon posto perché non segue il principio single responsibility, avendo messo la negoziazione di contenuti nella logica di routing.

Ho preso una pugnalata all'attuazione della contrattazione dei contenuti nel mio blog engine; rivedere questo potrebbe aiutarti a guidarti in una buona direzione. L'essenza è che il codice determina l'estensione del file tramite la negoziazione di negoziazione. Quindi, con l'estensione del file, vuole trovare il file di visualizzazione corrispondente, lo rende in una risposta e lo invia al client. L'idea è che risponda con la risorsa richiesta nella rappresentazione richiesta per la negoziazione del contenuto. Il routing logic specifica solo una vista, ma non ha idea della negoziazione del contenuto. Ciò accade al di fuori della logica di routing che rende il design più flessibile.

Il risultato di questo progetto è la possibilità di chiedere una rappresentazione specifica della risorsa come:

http://blog.joeyguerra.com/index.json e ottenere una rappresentazione JSON http://blog.joeyguerra.com/index.phtml e ottenere parziale (o un frammento di HTML) HTML rappresentazione http://blog.joeyguerra.com/index.xml e ottenere una rappresentazione XML.