‫Narratore: Quindi, la nostra API ora è praticamente finita.
‫E così in questo
‫video finale della sezione, creeremo rapidamente
‫la documentazione per l'API direttamente in Postman.
‫Ed è vero, possiamo
‫facilmente creare una documentazione rapida direttamente in Postman.
‫Ed è davvero importante disporre della documentazione
‫API in atto perché è così che comunichiamo ai membri del
‫team, o anche ai nostri utenti finali dell'API,
‫come possono effettivamente utilizzarla nella pratica.
‫Quindi lascia che ora ti mostri come funziona.
‫Ora, prima di poter effettivamente creare la documentazione,
‫facciamo un po' di pulizia qui.
‫Ad esempio, liberati di questa richiesta, va bene?
‫Un'altra cosa che voglio fare è qui nel punto di
‫accesso, in realtà esponiamo la nostra password qui.
‫E quindi non è una buona idea, quindi quello
‫che farò è creare una variabile
‫d'ambiente che conterrà questa password.
‫Dal momento che è sempre lo stesso, non dovrebbero esserci problemi.
‫Quindi, ricorda come lo facciamo.
‫Bene, veniamo qui alla gestione dell'ambiente
‫e quindi qui ne aggiungiamo semplicemente un altro.
‫Quindi password, test1234.
‫E qui questo non è corretto, quindi password, aggiornata, e ora facciamo
‫lo stesso anche qui
‫in produzione.
‫Quindi password, test1234.
‫E quindi, non aggiungere, ma chiudiamolo e quindi qui
‫ora posso aggiungere e usarlo, non in
‫una stringa, ma in questo modo.
‫Quindi password.
‫Quindi proviamolo.
‫E questo ci dà questo strano errore, ma la
‫nostra password è in realtà qui, quindi
‫probabilmente quello che dobbiamo fare è mettere davvero le virgolette qui.
‫Quindi proviamolo.
‫E così ora, in effetti, abbiamo effettuato l'accesso con successo.
‫Quindi salvalo ora, ok?
‫E quindi ora quello che dovremmo fare è creare
‫effettivamente una descrizione per ogni singola richiesta
‫che abbiamo nella nostra collezione.
‫Ora, ovviamente, non lo
‫farò, lo esemplificherò qui con il primo.
‫Va bene?
‫Quindi chiudiamo effettivamente questi altri
‫e quindi ora qui possiamo aggiungere una descrizione.
‫E quindi diciamo solo, usa questo endpoint
‫per creare un nuovo tour.
‫Ok, e di nuovo, ora dovresti fare esattamente la stessa cosa per
‫tutte le tue richieste se il tuo obiettivo è davvero pubblicare
‫e condividere la tua API, ok?
‫Quindi la stessa cosa vale per le cartelle
‫e non per rinominare, ma per modificare.
‫E così in ognuna
‫di queste cartelle possiamo effettivamente aggiungere anche una descrizione.
‫Quindi diciamo solo qualcosa di casuale come, puoi
‫ottenere tutti i tour, crearne di
‫nuovi e
‫modificare ed eliminare i tour.
‫Esistono anche endpoint speciali per alcuni
‫requisiti speciali.
‫Ok, e di nuovo questo è
‫totalmente casuale e pubblicherei qualcosa di simile per la
‫mia API, ma qui vogliamo solo testare come funziona, ok?
‫Come puoi vedere
‫qui sotto, puoi anche usare Mark qui sotto, ok?
‫Quindi, per esempio, per rendere il
‫testo in grassetto, puoi pensare che funzioni così, sì,
‫sembra che funzioni, e quindi
‫sì, puoi fare tutti i tipi di cose qui, ok?
‫Probabilmente puoi anche
‫creare una descrizione su
‫Natours stesso, quindi diciamo che l'API Natours
‫contiene endpoint per tour, utenti e recensioni.
‫E poi ancora un
‫sacco di cose, come potresti descrivere il tuo processo
‫di autenticazione, o le tue autorizzazioni e davvero
‫tutto ciò che l'utente deve sapere per utilizzare questa API, ok?
‫Quindi dovresti sempre
‫aggiungere una descrizione a tutte le richieste, a tutte
‫le cartelle e anche, ovviamente, alla collezione stessa.
‫Oh, e possiamo effettivamente descrivere i parametri di query in una
‫stringa di query, quindi facciamolo qui.
‫E possiamo anche dire che supporta gli
‫operatori maggiore di, minore di uguale, maggiore di e minore di.
‫Quindi di nuovo, solo un
‫esempio qui e salviamolo ora nella richiesta.
‫E quindi con questo penso che
‫dovremmo essere pronti a pubblicare effettivamente la nostra documentazione API.
‫E quindi per farlo, andiamo
‫qui all'opzione collection, e poi quaggiù,
‫pubblichiamo la documentazione.
‫E quindi dovrebbe aprire una finestra del browser, e per
‫me lo ha fatto al di fuori
‫del mio schermo, quindi fammi solo arrivare qui.
‫E così ora puoi scegliere l'ambiente.
‫Quindi qui dovremmo avere un elenco dei nostri ambienti,
‫che per qualche ragione non abbiamo, è strano, ma comunque, non volevamo
‫usare nessun ambiente comunque, perché ciò avrebbe quindi sostituito le
‫nostre variabili di ambiente
‫con i loro valori reali, e non
‫lo vogliamo.
‫Ad esempio, abbiamo usato la variabile
‫d'ambiente sulla password, in modo
‫che poi nella documentazione non sia realmente visibile, ok?
‫Quindi non vogliamo davvero usare alcun ambiente.
‫Ora potremmo anche usare un
‫dominio personalizzato, ma è solo per gli utenti a pagamento, ok?
‫Quindi potremmo anche cambiare tutto lo stile dell'API
‫in modo che corrisponda ai colori del tuo marchio,
‫ma di nuovo, non è necessario
‫in questo caso, quindi andiamo avanti e pubblichiamolo.
‫E così ora, questo è in
‫realtà pubblico, quindi tutti possono visualizzare la tua documentazione ora su questo URL.
‫Ora, per qualche ragione, non ha aggiornato tutti i cambiamenti che
‫abbiamo appena fatto prima, quindi è un po' strano.
‫Quindi torniamo da Postman e vediamo
‫cosa sta succedendo.
‫Forse ha a che fare con questa cosa che ruota qui,
‫quindi lascerò Postman e lo riaprirò.
‫E speriamo che lo risolva.
‫Quindi se ora ricarichiamo qui,
‫ahh allora otteniamo tutte le nostre modifiche effettivamente qui.
‫Quindi vedete, la descrizione che
‫abbiamo aggiunto per la collezione Natours, ok?
‫Quindi anche la descrizione per questa cartella e
‫la descrizione per questa richiesta.
‫E infine, come prima
‫descrizione, anche per questo parametro, ok?
‫Qui otteniamo quindi la variabile di ambiente
‫URL invece dell'URL effettivo.
‫Ora, naturalmente, potresti voler effettivamente fornire l'URL
‫reale qui e per questo
‫potresti semplicemente usare un altro ambiente.
‫Quindi qui sopra puoi effettivamente vedere tutti gli
‫ambienti ma sono privati, quindi in questo momento nessuno può usarli,
‫ma ricorda come
‫nel primo passaggio, avremmo potuto effettivamente creare
‫questa documentazione usando uno degli ambienti, e quindi probabilmente
‫lo faremmo abbiamo utilizzato l'ambiente di produzione per
‫quello e quindi con quello avremmo l'URL di produzione
‫finale qui negli URL delle nostre API, ok?
‫Ad ogni modo, ecco come
‫appare la documentazione, quindi ecco la richiesta di
‫esempio e possiamo cambiarla anche nella nostra lingua.
‫Quindi, in questo caso, Node
‫JS, ma se l'utente, ad esempio, esegue
‫una richiesta utilizzando jQuery, può semplicemente utilizzare jQuery, ok.
‫Quindi, solo per vedere questa richiesta di esempio qui, quindi con Node, sembra
‫qualcosa del genere.
‫Quindi, qui abbiamo tutti i nostri
‫endpoint e puoi vedere che quelli che richiedono l'autenticazione,
‫in realtà hanno questa icona di blocco qui.
‫E quindi nella tua descrizione ora puoi
‫aggiungere che dicendo che devi accedere, per accedere a questo
‫endpoint, e anche come puoi effettivamente accedere, ok.
‫Oppure puoi anche
‫descriverlo qui nella sezione di autenticazione, giusto?
‫Quindi, idealmente, avresti descrizioni per tutto questo.
‫Oh, e qui vedo
‫che in realtà ci siamo dimenticati di sostituire la vera
‫password, ma non importa perché questo è davvero solo un esempio, ok?
‫Ma ovviamente, ricevi tutte le
‫richieste che abbiamo avuto nel nostro postino anche qui.
‫Ora un'altra bella caratteristica qui è questo pulsante Esegui in Postman, e
‫quindi se qualcuno ha Postman installato sul proprio computer,
‫tutto ciò che deve fare è
‫fare clic qui e quindi aprire con la propria applicazione Postman.
‫Ora non lo farò in questo momento perché,
‫naturalmente, ce l'ho già nel mio postino, ma per il resto
‫questa è una funzionalità davvero interessante per gli utenti che possono andare
‫avanti e iniziare subito a sperimentare con la tua API.
‫Ok, e penso che sia davvero così, quindi questo
‫conclude la nostra sezione
‫e la nostra API è ora finalmente davvero completata.
‫Quindi ancora una volta, congratulazioni per essere arrivati fino a
‫questo punto nel corso, abbiamo
‫già coperto così tanto terreno qui insieme.
‫Ora il prossimo, c'è una sezione molto, molto eccitante
‫in avanti dove costruiremo finalmente il
‫volto dell'utente per il sito web di Natours.
‫Quindi, in pratica, utilizzeremo i
‫modelli per creare un sito Web completamente dinamico basato su
‫tutti i dati che abbiamo già nel nostro database.
‫Ed è davvero fantastico.
‫E quindi non vedo l'ora di mostrartelo.