Jak stworzyć RESTful API z wykorzystaniem Express.js i Node.js

słowa kluczowe:

W dzisiejszym artykule dowiesz się, jak stworzyć RESTful API przy użyciu Express.js i Node.js. Skupimy się na budowie prostego API do zarządzania listą zadań. Wymagane jest średnie doświadczenie w programowaniu w języku JavaScript i umiejętność pracy w wierszu poleceń.

Przygotowanie środowiska

Aby rozpocząć, utwórz nowy folder o nazwie „todo”:

$ mkdir todo $ cd todo

Następnie w folderze „todo” utwórz nowy plik o nazwie „app.js”:

$ touch app.js

Kolejnym krokiem będzie zainstalowanie Node.js. Możesz pobrać i zainstalować Node.js stąd https://nodejs.org/en/. Po zainstalowaniu Node.js zainstalujemy Express.js przy użyciu narzędzia npm, które jest dostarczane razem z Node.js.

Inicjalizacja aplikacji

Przejdź do głównego folderu projektu i uruchom następujące polecenie w wierszu poleceń:

npm init

Naciśnij klawisz Enter, aby odpowiedzieć na wszystkie pytania.

Polecenie to utworzy plik „package.json”, który będzie zawierał informacje o twoim projekcie.

Następnie zainstalujemy wymagane zależności, takie jak Express.js i Babel:

$ npm install express --save $ npm install babel-cli --save $ npm install babel-preset-es2015 --save

Babel jest narzędziem, które pozwala nam pisać kod w składni ES6, a następnie kompiluje go do składni ES5, aby był kompatybilny z starszymi przeglądarkami i wersjami Node.js.

Tworzenie bazy danych

Przed rozpoczęciem tworzenia API musimy utworzyć bazę danych, którą będziemy używać. W tym celu utwórz folder o nazwie „db” w głównym folderze projektu, a następnie utwórz plik o nazwie „db.js” wewnątrz tego folderu. W pliku „db.js” utwórz obiekt JavaScript, który będzie reprezentował naszą bazę danych:

const todos = [ { id: 1, title: "Obiad", description: "Odpoczynek na obiad o 14:00" } ]; export default todos;

Konfiguracja aplikacji i tworzenie pierwszego endpointu

Teraz możemy rozpocząć tworzenie naszego API. W pliku „app.js” dodajmy następujący kod:

import express from 'express'; import db from './db/db'; const app = express(); app.get('/api/v1/todos', (req, res) => { res.status(200).send({ success: true, message: "Pomyślnie pobrano listę zadań", todos: db }); }); const PORT = 5000; app.listen(PORT, () => { console.log(`Serwer uruchomiony na porcie ${PORT}`); });

W powyższym kodzie importujemy framework Express.js i naszą bazę danych z pliku „db.js”. Następnie tworzymy endpoint „/api/v1/todos”, który odpowiada na żądania GET i zwraca listę zadań w formacie JSON.

Teraz możemy uruchomić naszą aplikację przy użyciu polecenia:

$ node_modules/.bin/babel-node app.js

Po uruchomieniu aplikacji możemy przetestować nasz endpoint przy użyciu narzędzia Postman. Wpisz w przeglądarce adres „localhost:5000/api/v1/todos” i powinieneś otrzymać listę zadań w formacie JSON.

Podsumowanie

W tym artykule nauczyliśmy się, jak stworzyć RESTful API przy użyciu Express.js i Node.js. Rozpoczęliśmy od inicjalizacji projektu, zainstalowaliśmy niezbędne zależności, utworzyliśmy bazę danych i dodaliśmy pierwszy punkt końcowy (endpoint) do naszego API. Teraz możemy kontynuować rozwijanie naszego API, dodając kolejne punkty końcowe i implementując różne funkcje.

Różnice między Swaggerem a OpenAPI

Pamiętaj, że to tylko podstawy, a tworzenie zaawansowanych API wymaga dalszej nauki i eksperymentowania. Mam nadzieję, że ten artykuł był dla Ciebie pomocny i że będziesz kontynuować naukę i rozwijanie swoich umiejętności w zakresie tworzenia API. Powodzenia!

Czy ten artykuł był pomocny?
Tak Nie

Node.js