În acest tutorial vei învăța cum să adaugi un endpoint pentru serviciul de chat în aplicația ta Node.js. Scopul nostru este să creăm un simplu endpoint GET pentru URL-ul /api/chat, care va returna un răspuns către client. Acest endpoint va fi ulterior conectat la API-ul OpenAI pentru a genera completări de chat. Hai să începem și să parcurgem pașii necesari.
Cel mai important
- Crearea unui endpoint GET într-o aplicație Node.js
- Utilizarea JSON pentru transferul de date
- Integrarea cu API-ul OpenAI pentru completări de chat
Ghid pas cu pas
Pasul 1: Crearea directorului API
Pentru a garanta un cod curat, ar trebui să creezi un director special pentru endpoint-urile tale API. În proiectul tău React, ar trebui să creezi un nou subdirector sub directorul pages cu numele API.
Pasul 2: Crearea fișierului chat.js
În directorul API creat anterior, creează un fișier nou numit chat.js. Acest fișier va conține codul Node.js care va gestiona cererea de tip GET.
Pasul 3: Implementarea handler-ului GET
Trebuie să definesc un handler GET în fișierul chat.js. Acest handler va gestiona cererile primite la URL-ul /api/chat. Este important ca funcția să aibă numele get, deoarece acesta este un prereq [sic] pentru a fi recunoscută ca handler GET în Ast [sic].
Pasul 4: Returnarea unui răspuns simplu
Pentru moment, poți returna un răspuns JSON simplu. Pentru aceasta, folosește new Response() și inițializează răspunsul cu JSON.stringify(), pentru a serializa un obiect care conține o proprietate answer. Pentru acest prim răspuns de testare, poți pur și simplu să setezi „Salut“.
Pasul 5: Stabilirea stării și a antetului
În plus față de returnarea corpului răspunsului, poți adăuga și codul de stare și antetul. Setează starea la 200, ceea ce înseamnă că cererea a fost realizată cu succes, și definește Content-Type ca application/json, pentru a te asigura că clientul recunoaște răspunsul ca fiind JSON.
Pasul 6: Testarea endpoint-ului în browser
După ce ai setat totul, poți testa endpoint-ul. Deschide-ți browserul și accesează mediul tău de dezvoltare local, tastând URL-ul http://localhost:3000/api/chat. Ar trebui să vezi răspunsul pe care l-ai definit în faza anterioară.
Pasul 7: Verificarea returnării corecte
Dacă introduci URL-ul și vezi răspunsul JSON corect în browser, înseamnă că handler-ul GET funcționează. Această implementare simplă va constitui baza pentru extinderea ulterioară, în care vei integra API-ul OpenAI pentru completările de chat.
Pasul 8: Extinderea către API-ul OpenAI
Într-o sesiune viitoare, vom extinde endpoint-ul deja implementat pentru a obține completările de chat din API-ul OpenAI. Cu toate acestea, endpoint-ul curent îți va oferi deja înțelegerea de bază necesară pentru interacțiunile HTTP printr-un API.
Rezumat
În acest tutorial ai învățat cum să creezi un endpoint GET simplu pentru aplicația ta Node.js care returnează răspunsuri JSON. Această implementare de bază va servi ca fundament pentru extinderile viitoare, în special pentru integrarea API-ului OpenAI, despre care vom discuta în următorul videoclip.
Întrebări frecvente
Cum pot crea un subdirector în proiectul meu?Poți crea un subdirector în proiectul tău prin crearea unui director nou cu numele API în cadrul directorului pages.
De ce este important ca handler-ul meu GET să se numească get?În Astro, numele handler-ului este crucial pentru recunoașterea cererii HTTP corespunzătoare.
Cum îmi testez noul endpoint?Introdu URL-ul http://localhost:3000/api/chat în browser pentru a verifica răspunsul handler-ului tău GET.
Ce va fi discutat în următorul videoclip?În următorul videoclip, vom extinde endpoint-ul actual pentru a obține completări de chat din API-ul OpenAI.