Node.js to środowisko uruchomieniowe Javascript, które opiera się na silniku Javascript V8 Chrome. Node jest przeznaczony do budowy skalowalnych aplikacji sieciowych. W tym artykule skupiamy się na zbudowaniu REST API przy użyciu Node.js. Będziemy budować prostą usługę kalkulatora, która będzie wykonywać podstawowe obliczenia i zwracać wygenerowane wyniki.
co to jest REST API?
Simply a RESTful API to interfejs programistów aplikacji (API), który wykorzystuje żądanie HTTP do pobierania, publikowania, umieszczania, usuwania danych. Znany również jako RESTful web services. REST oznacza REpresentational State Transfer, który jest stylem architektonicznym dla rozwoju usług internetowych.
co zbudujemy?
będziemy budować prosty serwis internetowy, który zrobi kilka obliczeń i zwróci wartości. Adresy URL żądania i out put będą wyglądać tak.
czego potrzebujesz
- miły edytor kodu, taki jak Visual Studio Code.
- węzeł.js zainstalowany w Twoim systemie.
- framework usługi-w tym artykule używam hapi.js (wymawiane jako Happy JS)
- aplikacja typu POSTMAN (rozszerzenie aplikacji chrome) do testowania naszej usługi.
jestem w systemie MacOS High Sierra w wersji 10.13.3. Polecenia powłoki muszą być podobne na innych platformach.
zaczynajmy
Kliknij tutaj, aby uzyskać pełną próbkę roboczą.
przede wszystkim musisz sprawdzić wersję Node.js masz. Otwórzmy terminal i wpisz następujące polecenie, aby sprawdzić wersję węzła.js masz. Używam wersji 8.9.4
$ node --version
ok, teraz utwórz katalog do przechowywania kodu i przejdź do niego za pomocą następujących poleceń powłoki.
$ mkdir calc-service
$ cd calc-service
pozwala stworzyć nasz projekt.pliku json, wpisując to polecenie.
$ npm init
Odpowiedz na pytania i swój projekt.plik json powinien wyglądać tak.
miło, teraz stworzyliśmy bazę naszego węzła.js service. Następnie musimy zainstalować hapi.js framework. hapi.js to bogaty framework pozwalający na tworzenie aplikacji internetowych jak i usług opartych o Node.js.
lets goto terminala i wpisz i wprowadź następujące polecenie.
$ npm install --save [email protected]
npm to menedżer pakietów, który pozwala zainstalować tysiące modułów do pracy z węzłem.js. Jeśli spojrzysz na powyższe polecenie, poinstruowaliśmy npm, aby zainstalował hapi w wersji 17. Poprosiliśmy również o aktualizację pakietu.plik json za pomocą opcji Zapisz.
teraz twoja struktura folderów powinna wyglądać tak.
jak widzisz hapi.zależność js została zaktualizowana w pakiecie.plik json, jak również wymagane node_modules są aktualizowane.
stwórzmy teraz serwer
w tym kroku będziemy szukać serwera, który będzie nasłuchiwał naszych żądań. W terminalu wpisz następujące polecenie do utworzenia serwera.plik js. To musi znajdować się w katalogu głównym katalogu, w którym się znajdujesz. Możesz też użyć nowego pliku na karcie lewy panel w kodzie VS.
$ touch server.js
dodajmy następujący kod do serwera.plik js. Ten kod stworzy kod, który będzie nasłuchiwał żądań użytkowników na danym porcie.
pozwala sprawdzić, czy serwer jest uruchomiony. Otwórz terminal i następujące polecenie.
$ node server.js
i powinieneś zobaczyć out put w ten sposób.
utwórz naszą pierwszą trasę
teraz pomyślnie przetestowaliśmy serwer. Nasz serwer jest już uruchomiony. Czas stworzyć pierwszą trasę. Zacznijmy od stworzenia tej ścieżki.
/calculator/about
Otwórz serwer.js pliku i dodać następujący kod, tuż przed init().
powyższy kod tworzy trasę do ścieżki give/calculator / about przy użyciu metody GET. W linii 4 Funkcja obsługi obsługuje żądanie i wysyła odpowiedź jako odpowiedź. W linii 5 stworzyliśmy zmienną, która przechowuje łańcuch JSON. Na koniec linia zwraca tę zmienną jako odpowiedź z serwera.
teraz dodaliśmy naszą pierwszą trasę do serwera. Zróbmy szybki test nowego kodu. W terminalu wpisz następujące polecenie, aby uruchomić serwer. (Możesz zatrzymać serwer naciskając CTRL + C)
$ node server.js
odpala listonosza i testuje naszą pierwszą trasę.
jak widzisz, użyliśmy metody GET do wysłania żądania, A adres URL pasuje do ścieżki trasy. Mamy pomyślny powrót z serwera jako łańcuch JSON.
Excellent mamy teraz działający kod. Jego dobrą praktyką jest trochę organizowanie kodu. Mimo że jest to mała aplikacja, zawsze jest to dobra praktyka. Przenieśmy nasz kod routingu do osobnego folderu i Pliku.
najpierw zatrzymamy serwer naciskając CTRL + C w terminalu. W katalogu głównym utwórz katalog o nazwie routes. Użyj następujących poleceń w terminalu lub możesz go utworzyć za pomocą kodu VS.
$ mkdir routes
$ cd routes
$ touch routes.js
teraz struktura katalogów powinna wyglądać tak.
teraz otwórz trasę.plik js w kodzie VS. Następnie wytnij kod, który napisaliśmy do routingu na serwerze.plik js. I wkleić wewnątrz trasy.plik js. Teraz ponownie otwórz serwer.plik js dodaje następujący kod tuż przed wywołaniem metody init ().
require(‘./routes/routes’)(server);
teraz mamy trochę uporządkowany kod. Dodajmy resztę tras do tras.plik js.
teraz wszystkie nasze trasy są nienaruszone. Jeśli spojrzysz na numery linii 19, 36, 53 i 70, ścieżka ma dwa wpisy w nawiasach {}. Są one traktowane jako parametry w ścieżce. Możesz uzyskać dostęp do tych parametrów, jak pokazano w liniach 22 i 23. Reszta jest oczywista.
teraz zaznaczamy serwer wpisując to polecenie w terminalu i testujemy za pomocą POSTMANA.
$ node server.js
Congratulations. You have written your first Node.js based REST API service.
Happy Coding 🙂 !!!