Richiesta API esterna

Non c'è troppa teoria?

Mettiamola in pratica. Apriamo AppMaster, creiamo una richiesta API e capiamo meglio come funziona questa richiesta.

Creazione di una richiesta API esterna

Le richieste API vengono create nella sezione "Logica aziendale", nella scheda "Richieste API esterne".

È il momento di fare clic su "+ Nuova richiesta API".

Il nome e la descrizione possono essere impostati a piacere, sono solo per uso personale.

Passiamo ai dati che contano davvero.

Il minimo indispensabile per creare una richiesta è specificarne il Metodo e l'indirizzo (URL). Cominciamo con l'ultimo.

URL

URL - Uniform Resource Locator. Un indirizzo dato a una particolare risorsa su Internet. La versione più familiare di tale risorsa è una pagina HTML: inseriamo il suo URL nella barra degli indirizzi del browser e apriamo il sito desiderato. Allo stesso tempo, la risorsa stessa può essere qualsiasi cosa, un'immagine, un video, un insieme di dati. L'importante è che questa risorsa abbia un puntatore specifico - un URL al quale è possibile inviare una richiesta per ottenere questa risorsa.

I metodi

Facendo riferimento ai dati al loro indirizzo, si indica anche il metodo (si può anche dire il tipo) della richiesta, cioè si indica che cosa deve essere fatto con questi dati.

Quando abbiamo inviato le richieste per il task del primo modulo, abbiamo ricevuto dei dati. Questo è il metodo GET. Questo metodo è il più ovvio e anche l'unico richiesto. Pertanto, anche se non lo abbiamo specificato esplicitamente, è stato comunque assunto come predefinito che si trattasse di GET.

Vediamo quali altri metodi esistono.

Lo stesso standard HTTP non limita il numero di metodi che possono essere utilizzati. Allo stesso tempo, per mantenere la compatibilità, vengono utilizzati solo alcuni dei metodi più standard. Esistono 5 metodi diversi che possono essere utilizzati nelle richieste API di AppMaster.

GET. È già stato trattato. Il metodo richiede la fornitura di una risorsa e riceve i dati.

POST. Per prelevare i dati da un luogo, è necessario prima collocarli. Il metodo POST fa proprio questo. Invia i dati al server e crea una risorsa.

PUT. Simile al metodo POST, ma il suo compito è aggiornare i dati. Non crea nuovi dati, ma sostituisce quelli esistenti, li aggiorna.

DELETE. Come suggerisce il nome, cancella i dati.

PATCH. Il metodo è simile a PUT, ma viene utilizzato per aggiornare parzialmente i dati, anziché sostituirli completamente. Ad esempio, con il metodo PATCH è possibile modificare il titolo di un articolo o il valore di un parametro.

È importante considerare il fatto che il server non è tenuto a fare esattamente ciò che viene specificato nel metodo. Possiamo inviare l'indirizzo di una pagina con il metodo DELETE, ma questo non significa che il server la cancellerà effettivamente. Ma, in linea puramente teorica, può farlo con il comando GET. Oppure non modificare nulla, ma allo stesso tempo inviare dati in risposta a POST. Solo perché lo sviluppatore l'ha configurato in questo modo.

È qui che entra in gioco REST, che dice che è ora di concordare il rispetto dell'ordine, fermare il disordine e fare esattamente ciò che è indicato nel metodo. Come minimo, questo dovrebbe essere il compito principale (anche se non necessariamente l'unico). Ad esempio, quando si trasferisce il contenuto di un articolo con il metodo GET, si può allo stesso tempo aumentare di 1 il contatore del numero di visualizzazioni.

Abbiamo quindi capito dove si trovano i dati e cosa si può fare con essi. Andiamo oltre, vediamo quali altri componenti può avere la richiesta.

Parametri dell'URL

Parametri dell'URL. Ci sono situazioni in cui conosciamo solo una parte dell'URL. Un esempio sono gli articoli del sito web Appmaster.io. L'indirizzo iniziale di tutti gli articoli è lo stesso: https: //appmaster.io/blog/. Ma ogni articolo ha il proprio titolo e, di conseguenza, la propria parte individuale per l'indicazione esatta di questo particolare articolo.

In questa situazione, si utilizzano gli URL Params. Si prescrive subito la parte generale e si lascia che il resto venga deciso in corso d'opera. Di conseguenza, l'URL è scritto nella forma https://appmaster.io/blog/:id/.

La parte nota è scritta così com'è, mentre la parte variabile è posta dopo il segno ":". Il nome di questa parte variabile (già senza ":") viene aggiunto all'elenco dei parametri. In questo caso, possono esserci più parti variabili e la loro posizione è qualsiasi punto dell'URL.

Parametri della query

Parametri della query. Ricordate quando abbiamo inviato una richiesta a boredapi.com nel primo modulo? Oltre all'indirizzo, sono stati richiesti altri dati. Si trattava dei Query Params.

Sono scritti dopo l'URL e sono separati da un segno "?". Vengono indicati il nome del parametro, il segno "=" e il valore del parametro stesso. Se si utilizzano più parametri contemporaneamente, essi sono separati dal segno "&".

Tuttavia, quando si specificano i parametri in AppMaster, non è necessario pensare alle regole di richiesta. Tutto sarà formattato automaticamente. È sufficiente specificare il nome del parametro stesso e aggiungerlo all'elenco.

I parametri di query sono utilizzati quando l'origine dei dati è la stessa, ma i dati stessi possono essere diversi. Ad esempio, Boredapi conteneva un enorme elenco di cose da fare. Ma a noi interessavano solo quelle destinate a una persona e questo è ciò che abbiamo specificato nei parametri della richiesta.

Un altro caso d'uso è quello di limitare la quantità di dati. Ad esempio, potremmo accedere a un elenco, ma richiedere solo le prime 5 voci. Anche questa quantità può essere un parametro della query.

Un'altra opzione è una chiave di accesso. È possibile che questa opzione sia stata utilizzata nel modulo 1, in riferimento ad Alphavantage. I dati possono essere ottenuti solo dopo la registrazione e l'invio di una chiave personale nei parametri di richiesta.

Prestate attenzione alle pagine che visitate su Internet, probabilmente troverete vari parametri anche in esse. Ad esempio, aprendo la pagina meteo di Ventusky.com, nei parametri di richiesta vengono inviati i valori geografici di latitudine e longitudine.

Intestazioni

Intestazioni. Intestazioni della richiesta. Di solito le intestazioni contengono informazioni di servizio sulla richiesta (meta-informazioni). Le intestazioni consentono al server di ottenere ulteriori informazioni sul client che sta richiedendo i dati. Le intestazioni possono contenere informazioni sul browser utilizzato, sulla codifica prevista per la risposta, sulla lingua, sull'ora esatta della richiesta e altro ancora. Nel caso di accesso a dati protetti, le intestazioni possono contenere una chiave di autorizzazione.

Nella maggior parte dei casi, le intestazioni sono facoltative. Già nel primo modulo abbiamo fatto una richiesta in cui non abbiamo specificato alcuna intestazione (anche se questo non significa che la richiesta sia stata effettivamente inviata senza intestazioni).

Corpo

Corpo. Corpo della richiesta. Le richieste GET di solito ne fanno a meno, ma se vogliamo inviare alcuni dati al server, inviando una richiesta POST o PUT, questi dati vengono inseriti nel corpo della richiesta. Allo stesso tempo, è possibile inserire nel corpo della richiesta dati di qualsiasi complessità, ad esempio inviare un file video, senza limitarsi a un numero o a una stringa di testo.