Manuale · 7

Endpoint personalizzati

Collega uno script a una rotta HTTP propria sotto /api/v1/scripts/*.

Configurazione:

  • Metodo HTTP (qualsiasi).
  • Pattern del percorso – sono ammessi segmenti fissi, parametri con nome (:id) e un carattere jolly finale (*), ad es. /ordini/:id/stato. Se più pattern registrati corrispondono a una stessa richiesta, vince il più specifico (fisso prima di parametro con nome prima di carattere jolly).
  • Modalità di autenticazione: pubblico (raggiungibile senza accesso) oppure autenticato (richiede sessione o token API).

L'oggetto request

Lo script ha a disposizione un oggetto globale request:

request.method   // "GET", "POST", ...
request.path     // il percorso chiamato
request.params   // parametri di percorso con nome, ad es. { id: "42" }
request.query    // parametri della query string
request.headers  // header HTTP
request.body     // JSON già analizzato, altrimenti il testo grezzo

La risposta

O tramite l’oggetto response (concatenabile):

response.status(201).json({ ok: true });
// oppure: response.send("testo semplice");
// oppure: response.setHeader("X-Custom", "valore");

Oppure semplicemente l’ultima espressione/il valore di return dello script – viene allora restituito automaticamente come JSON, senza alcuna chiamata a response.*.