Scrivere il primo Nodo.servizio API REST js

Nodo.js è un runtime Javascript che si basa sul motore Javascript V8 di Chrome. Node è progettato per creare applicazioni di rete scalabili. Il nostro obiettivo in questo articolo è quello di creare un’API REST utilizzando Node.js. Costruiremo un semplice servizio di calcolatrice che eseguirà calcoli di base e restituirà gli output generati.

Che cos’è un’API REST?

Semplicemente un’API RESTful è un’API (Application Programmers Interface) che utilizza la richiesta HTTP per OTTENERE, PUBBLICARE, INSERIRE, ELIMINARE i dati. Conosciuto anche come RESTful web services. REST sta per REpresentational State Transfer, che è uno stile architettonico per lo sviluppo di servizi web.

Cosa costruiremo?

Costruiremo un semplice servizio web che farà alcuni calcoli e restituirà i valori. Gli URL di richiesta e l’out put saranno simili a questo.

Di cosa hai bisogno

  1. Un piccolo editor di codice come Visual Studio Code.
  2. Nodo.js installato nel sistema.
  3. Un framework di servizi — In questo articolo sto usando hapi.js (pronunciato come Felice JS)
  4. Un app come POSTMAN (un’estensione app Chrome) per testare il nostro servizio.

Sono in macOS High Sierra versione 10.13.3. I comandi della shell devono essere simili su altre piattaforme.

Consente di iniziare

Fare clic qui per ottenere il campione di lavoro completo.

Prima di tutto è necessario controllare la versione del Nodo.js che hai. Consente di aprire un terminale e digitare il seguente comando per controllare la versione del nodo.js che hai. Sto usando la versione 8.9.4

$ node --version

OK, ora creare una directory per memorizzare il codice, e navigare in esso utilizzando i seguenti comandi di shell.

$ mkdir calc-service
$ cd calc-service

Consente di creare un nostro progetto.file json, digitando questo comando.

$ npm init

Rispondi alle domande e al tuo progetto.il file json dovrebbe assomigliare a questo.

Bello, ora abbiamo creato la base del nostro Nodo.servizio js. La prossima cosa che dobbiamo installare l’hapi.js quadro. hapi.js è un framework ricco che consente di creare applicazioni Web e servizi basati sul Nodo.js.

Consente di andare al terminale e digitare e immettere il seguente comando.

$ npm install --save [email protected]

npm è un gestore di pacchetti che consente di installare migliaia di moduli per lavorare con il nodo.js. Se si guarda il comando di cui sopra abbiamo incaricato il npm di installare hapi versione 17. Inoltre abbiamo chiesto di aggiornare il pacchetto.file json utilizzando l’opzione Salva.

Ora la struttura delle cartelle dovrebbe essere simile a questa.

hapi.js aggiornato come dipendenza

Come vedi l’hapi.la dipendenza js è stata aggiornata nel pacchetto.il file json e i node_modules richiesti vengono aggiornati.

Consente di creare il server ora

In questo passaggio cercheremo di creare un server che ascolterà le nostre richieste. Nel tipo di terminale seguente comando per creare il server.file js. Questo deve essere nella radice della directory in cui ti trovi. Oppure puoi usare il nuovo file nella scheda del riquadro di sinistra in VS Code.

$ touch server.js

Crea nuovo file

Consente di aggiungere il codice riportato di seguito nel server.file js. Questo codice creerà codice che ascolterà le richieste degli utenti su una determinata porta.

Consente di verificare se il server è attivo e funzionante. Aprire il terminale e il seguente comando.

$ node server.js 

E dovresti vedere un out put come questo.

Server in esecuzione sulla porta 3000

Creare il nostro primo itinerario

Ora che abbiamo testato con successo il server. Il nostro server è attivo e funzionante ora. È tempo di creare il primo percorso. Consente di iniziare semplice creando questo percorso.

/calculator/about

Aprire il server.file js e aggiungere il seguente codice, poco prima di init().

Sopra il codice crea un percorso per un percorso dare di/calcolatrice / sull’utilizzo di un metodo GET. Nella riga 4 la funzione gestore gestisce la richiesta e invia una risposta come risposta. Nella riga 5 abbiamo creato una variabile che memorizza una stringa JSON. Infine line restituisce quella variabile come risposta dal server.

Ora abbiamo aggiunto il nostro primo percorso al server. Consente di avere un test rapido sul nuovo codice. Nel terminale digitare il seguente comando per avviare il server. (Puoi fermare il server premendo CTRL + C)

$ node server.js

Consente di accendere il POSTINO e testare il nostro primo percorso.

ritorno al Successo dal server per testare il percorso.

Come vedi abbiamo usato il metodo GET per inviare la richiesta e l’URL corrisponde al percorso del percorso. Abbiamo un ritorno riuscito dal server come stringa JSON.

Eccellente abbiamo un codice di lavoro in questo momento. La sua buona pratica per organizzare un codice un po’. Anche se questa è una piccola applicazione, è sempre una buona pratica per farlo. Consente di spostare il nostro codice di routing in una cartella e un file separati.

Consente di arrestare il server prima premendo CTRL + C nel terminale. E nella directory principale, crea una directory denominata routes. Usa i seguenti comandi nel terminale o puoi crearlo usando il codice VS.

$ mkdir routes 
$ cd routes
$ touch routes.js

Ora la struttura della directory dovrebbe essere simile a questa.

struttura di Directory, dopo la creazione di percorsi di directory e file.

Ora apri il percorso.file js all’interno del codice VS. Quindi tagliare il codice che abbiamo scritto per il routing nel server.file js. E incolla all’interno del percorso.file js. Ora apri di nuovo il server.file js aggiungere il seguente codice appena prima di init () chiamata al metodo.

require(‘./routes/routes’)(server);

Ora abbiamo un po ‘ di codice organizzato. Consente di aggiungere il resto dei percorsi ai percorsi.file js.

Ora tutti i nostri percorsi sono intatti. Se si guardano i numeri di riga 19, 36, 53 e 70, il percorso ha due voci all’interno delle parentesi {}. Questi sono trattati come parametri nel percorso. È possibile accedere a questi parametri come mostrato nelle righe 22 e 23. Il riposo è auto-esplicativo.

Ora consente di star il server digitando questo comando nel terminale e testarlo usando POSTMAN.

$ node server.js 

Tested path of /calculator/add/10/20

Congratulations. You have written your first Node.js based REST API service.

Happy Coding 🙂 !!!

Lascia un commento

Il tuo indirizzo email non sarà pubblicato.