W tym samouczku nauczysz się, jak dodać punkt końcowy usługi czatu do swojej aplikacji Node.js. Naszym celem jest utworzenie prostego punktu końcowego GET dla adresu URL /api/chat, który następnie zwróci odpowiedź do Klienta. Później ten punkt końcowy zostanie połączony z OpenAI API, aby generować uzupełnienia czatu. Przejdźmy więc od razu do tego i omówmy wymagane kroki.
Najważniejsze punkty
- Utworzenie punktu końcowego GET w aplikacji Node.js
- Użycie formatu JSON do przesyłania danych
- Integracja z API OpenAI dla uzupełnień czatu
Krok po kroku
Krok 1: Utwórz folder API
Aby zapewnić czysty kod, powinieneś utworzyć specjalny folder na punkty końcowe API. W projekcie React powinieneś utworzyć nowy podfolder o nazwie API w katalogu pages.
Krok 2: Utwórz plik chat.js
W właśnie utworzonym folderze API utwórz nowy plik o nazwie chat.js. Ten plik będzie zawierać kod Node.js obsługujący żądanie GET.
Krok 3: Implementacja obsługi GET
Musisz zdefiniować obsługę GET w pliku chat.js. Ta obsługa będzie przetwarzać przychodzące żądanie pod adres URL /api/chat. Ważne jest, aby funkcja miała nazwę get, ponieważ jest to wymóg, aby została rozpoznana jako obsługa GET przez Astro.
Krok 4: Zwróć prostą odpowiedź
Jak na razie możesz zwrócić prostą odpowiedź w formacie JSON. W tym celu użyj new Response() i zainicjuj odpowiedź za pomocą JSON.stringify(), aby zserializować obiekt zawierający właściwość answer. Dla tego pierwszego testowego odpowiedzi po prostu ustaw „Hello“.
Krok 5: Ustaw status i nagłówek
Oprócz zwracania treści odpowiedzi, możesz również dodać status kodowy i nagłówek. Ustaw status na 200, co oznacza udane żądanie, i zdefiniuj Content-Type jako application/json, aby upewnić się, że Klient rozpoznaje odpowiedź jako JSON.
Krok 6: Testuj punkt końcowy w przeglądarce
Po skonfigurowaniu wszystkiego, możesz przetestować punkt końcowy. Otwórz przeglądarkę i przejdź do swojego lokalnego środowiska deweloperskiego, wpisując adres URL http://localhost:3000/api/chat. Powinieneś zobaczyć odpowiedź, której zdefiniowałeś w poprzedniej fazie.
Krok 7: Sprawdź poprawność odpowiedzi
Jeśli wpiszesz adres URL i zobaczysz właściwą odpowiedź JSON w przeglądarce, oznacza to, że obsługa GET działa. To proste wdrożenie będzie podstawą dla późniejszej rozszerzonej integracji, w której zintegrujesz OpenAI API dla uzupełnień czatu.
Krok 8: Rozwinięcie do OpenAI API
W przyszłej sesji rozbudujemy już zaimplementowany punkt końcowy, aby pobierać uzupełnienia czatu z API OpenAI. Aktualny punkt końcowy już jednak zapewni Ci niezbędną wiedzę o interakcjach HTTP z API.
Podsumowanie
W tym samouczku nauczyłeś się, jak tworzyć prosty punkt końcowy GET dla swojej aplikacji Node.js, zwracający odpowiedzi w formacie JSON. To podstawowa implementacja stanowi fundament dla przyszłych rozszerzeń, zwłaszcza dla integracji z API OpenAI, którą omówimy w kolejnym filmie.
Najczęstsze pytania
Jak utworzyć podfolder w moim projekcie?Możesz utworzyć podfolder w swoim projekcie, tworząc nowy folder o nazwie API w katalogu pages.
Dlaczego ważne jest, aby moja obsługa GET nazywała się get?W Astro nazwa obsługi jest kluczowa dla rozpoznania odpowiedniego żądania HTTP.
Jak przetestować mój nowy punkt końcowy?Wprowadź adres URL http://localhost:3000/api/chat w przeglądarkę, aby sprawdzić odpowiedź Twojej obsługi GET.
Co zostanie omówione w następnym filmie?W następnym filmie rozbudujemy aktualny punkt końcowy, aby pobierać uzupełnienia czatu z API OpenAI.