Node.js on Javascript-runtime, joka perustuu Chromen V8 Javascript-moottoriin. Node on suunniteltu rakentamaan skaalautuvia verkkosovelluksia. Keskitymme tässä artikkelissa rakentamaan REST API solmun avulla.js. Rakennamme yksinkertaisen Laskupalvelun, joka tekee peruslaskelmat ja palauttaa tuotetut tuotokset takaisin.
mikä on REST API?
Simply a RESTful API on applications programmers interface (API), joka käyttää HTTP-pyyntöä tietojen saamiseksi, lähettämiseksi, laittamiseksi, poistamiseksi. Tunnetaan myös levollisina verkkopalveluina. REST on lyhenne sanoista REpresentational State Transfer, joka on arkkitehtuurinen tapa kehittää verkkopalveluita.
mitä aiomme rakentaa?
rakennamme yksinkertaisen verkkopalvelun, joka tekee joitakin laskelmia ja palauttaa arvot takaisin. Pyynnön URL ja ulos laittaa näyttää tältä.
mitä tarvitset
- kiva pieni koodieditori kuin Visual Studio Code.
- solmu.js asennettu järjestelmään.
- palvelukehys — tässä artikkelissa käytän hapia.js (lausutaan Happy JS)
- Postmanin kaltainen sovellus (chrome app extension) testaamaan palveluitamme.
olen macOS High Sierra-versiossa 10.13.3. Komentotulkin komentojen on oltava samanlaisia muilla alustoilla.
Lets get started
Click here to get the full working sample.
ensin täytyy tarkistaa solmun versio.niin olet. Avaa pääte ja kirjoita seuraava komento tarkistaaksesi solmun version.niin olet. Käytän versiota 8.9.4
$ node --version
OK, luo nyt kansio, johon voit tallentaa koodin, ja navigoida siihen käyttämällä seuraavia komentotulkin komentoja.
$ mkdir calc-service
$ cd calc-service
Lets create a our project.JSON-tiedosto, kirjoittamalla Tämä komento.
$ npm init
vastaa kysymyksiin ja projektiisi.JSONin tiedoston pitäisi näyttää tältä.
kiva, nyt on Solmumme pohja luotu.JS-palvelu. Seuraavaksi pitää asentaa hapi.JS framework. hapi.JS on rikas kehys, jonka avulla voit luoda web-sovelluksia sekä solmuun perustuvia palveluja.js.
antaa päätteen ja kirjoittaa ja syöttää seuraavan komennon.
$ npm install --save [email protected]
npm on pakettihallinta, jonka avulla voi asentaa tuhansia moduuleja toimimaan solmun kanssa.js. Jos katsot yllä olevaa komentoa, olemme ohjeistaneet npm: ää asentamaan hapin version 17. Olemme myös pyytäneet paketin päivittämistä.JSON tiedosto käyttäen Tallenna vaihtoehto.
nyt kansiorakenteen pitäisi näyttää tältä.
kuten näet hapin.JS-riippuvuus on päivitetty pakettiin.JSON tiedosto sekä tarvittavat node_modules päivitetään.
Lets create the server now
in this step we will looking creating server that will listen to our requests. Päätetyypissä komennon jälkeen luoda palvelin.JS-tiedosto. Tämän täytyy olla hakemiston juuressa, jossa olet. Tai voit käyttää uutta tiedostoa vasempaan paneeliin-välilehdessä VS-koodissa.
$ touch server.js
div>
antaa lisätä palvelimeen seuraavan koodin.JS-tiedosto. Tämä koodi luo koodin, joka kuuntelee käyttäjän pyyntöjä tietyssä portissa.
tarkastetaan, onko palvelin toiminnassa. Avaa pääte ja seuraava komento.
$ node server.js
ja pitäisi nähdä tällainen ulosajo.
luo ensimmäinen reittimme
nyt palvelinta on testattu onnistuneesti. Palvelimemme toimii nyt. On aika luoda ensimmäinen reitti. Aloitetaan yksinkertaisesti luomalla tämä polku.
/calculator/about
avaa palvelin.JS tiedosto ja lisätä seuraavan koodin, juuri ennen init ().
yllä oleva koodi luo reitin/calculator / – polulle GET-menetelmällä. Rivillä 4 käsittelijä-toiminto käsittelee pyynnön ja lähettää vastauksen vastaukseksi. Rivillä 5 olemme luoneet muuttujan, joka tallentaa JSON-merkkijonon. Lopuksi line palauttaa muuttujan vastaukseksi palvelimelta.
nyt on lisätty ensimmäinen reitti palvelimelle. Tehdään pikatesti uudesta koodista. Kirjoita päätteessä seuraava komento palvelimen käynnistämiseksi. (Palvelimen voi pysäyttää painamalla CTRL + C)
$ node server.js
antaa tulittaa postinkantajaa ja testata ensimmäistä reittiämme.
kuten näet, olemme käyttäneet GET-menetelmää pyynnön lähettämiseen ja URL vastaa reitin polkua. Meillä on onnistunut paluu palvelimelta JSON merkkijono.
erinomainen meillä on toimiva koodi juuri nyt. Sen hyvä käytäntö järjestää koodi hieman. Vaikka tämä on pieni sovellus, se on aina hyvä käytäntö tehdä se. Siirretään reitityskoodi erilliseen kansioon ja tiedostoon.
pysäytetään palvelin ensin painamalla CTRL + C päätteessä. Luo juurihakemistoon kansio nimeltä reitit. Käytä seuraavia komentoja päätteessä tai voit luoda sen käyttämällä VS-koodia.
$ mkdir routes
$ cd routes
$ touch routes.js
nyt hakemistorakenteen pitäisi näyttää tältä.
hakemistorakenne routes Directoryn ja tiedoston luomisen jälkeen.
avaa nyt reitti.JS tiedosto sisällä VS koodi. Leikkaa seuraavaksi koodi, jonka kirjoitimme reititystä varten palvelimeen.JS-tiedosto. Ja liitä reitin sisään.JS-tiedosto. Nyt taas avaa palvelin.js-tiedosto Lisää seuraava koodi juuri ennen init () – menetelmän kutsua.
require(‘./routes/routes’)(server);
nyt meillä on vähän järjestäytynyttä koodia. Lets lisätä loput reitit reittejä.JS-tiedosto.
nyt kaikki reittimme ovat ehjiä. Jos katsot rivinumeroita 19, 36, 53 ja 70, polulla on kaksi merkintää {} suluissa. Näitä käsitellään polun parametreina. Voit käyttää näitä parametreja rivien 22 ja 23 mukaisesti. Lepo on itsestään selvää.
nyt voit tähdätä palvelinta kirjoittamalla tämän komennon päätteeseen ja testata sitä Postmanin avulla.
$ node server.js
Congratulations. You have written your first Node.js based REST API service.
Happy Coding 🙂 !!!