Enkel vejledning til oprettelse af en GET-endepunkt til chat-tjenesten i Node.js

I denne vejledning vil du lære, hvordan du kan tilføje en endpoint til chat-tjenesten i din Node.js-applikation. Vores mål er at oprette en simpel GET-endpoint for URL'en /api/chat, som derefter returnerer et svar til klienten. Denne endpoint vil senere blive forbundet med OpenAI API'en for at generere chat-kompletioner. Lad os komme i gang og gå igennem de nødvendige trin.

Vigtigste indsigter

• Oprettelse af en GET-endpunkt i en Node.js-applikation
• Brug af JSON til dataoverførsel
• Integration med OpenAI API'en for chat-kompletioner

Trin-for-trin vejledning

Trin 1: Opret API-mappen

For at sikre ren kode bør du oprette en speciel mappe til dine API-endpoints. I dit React-projekt bør du oprette en ny undermappe med navnet API under pages-mappen.

Trin 2: Opret chat.js-filen

I den netop oprettede API-mappe, opret en ny fil med navnet chat.js. Denne fil vil indeholde Node.js-koden, der håndterer GET-forespørgslen.

Trin 3: Implementer GET-handleren

Du skal definere en GET-handler i chat.js-filen. Denne handler vil håndtere indkommende forespørgsler til URL'en /api/chat. Det er vigtigt, at funktionen har navnet get, da dette er en forudsætning for at blive genkendt som en GET-handler i Astro.

Trin 4: Returner et simpelt svar

For øjeblikket kan du returnere et simpelt JSON-svar. Brug new Response() og initialiser responsen med JSON.stringify() for at serialisere et objekt, der indeholder et svar-ejendom. Til dette første test-svar kan du blot angive "Hej".

Trin 5: Angiv status og header

Udover at returnere kroppen af responsen, kan du også tilføje statuskoden og overskrifterne. Sæt status til 200, hvilket betyder, at forespørgslen var vellykket, og definer Content-Type som application/json for at sikre, at klienten genkender svaret som JSON.

Trin 6: Test endpointet i browseren

Når alt er sat op, kan du teste endpointet. Åbn din browser og gå til din lokale udviklingsmiljø ved at indtaste URL'en http://localhost:3000/api/chat. Du skal se svaret, du har defineret i den forrige fase.

Trin 7: Kontroller korrekt returnering

Hvis du indtaster URL'en og ser det korrekte JSON-svar i browseren, betyder det, at din GET-handler fungerer. Denne enkle implementering vil danne grundlag for fremtidig udvidelse, hvor du vil integrere OpenAI API'en for chat-kompletioner.

Trin 8: Udvidelse til OpenAI API

I en kommende session vil vi udvide den allerede implementerede endpoint for at hente chat-kompletioner fra OpenAI API'en. Den nuværende endpoint vil dog allerede give dig den nødvendige grundlæggende forståelse for HTTP-interaktionerne via API'en.

Opsamling

I denne vejledning har du lært, hvordan du opretter en simpel GET-endpunkt til din Node.js-applikation, der returnerer JSON-svar. Denne grundlæggende implementering danner grundlaget for fremtidige udvidelser, især for integrationen af OpenAI API'en, som vi vil behandle i den næste video.