I den här handledningen kommer du att lära dig hur du kan lägga till en ändpunkt för chatt-tjänsten i din Node.js-applikation. Vårt mål är att skapa en enkel GET-ändpunkt för URL:en /api/chat som sedan returnerar ett svar till klienten. Den här ändpunkten kommer senare att anslutas till OpenAI API för att generera chatt-kompletteringar. Låt oss börja direkt och gå igenom de nödvändiga stegen.
Viktigaste insikterna
- Skapa en GET-ändpunkt i en Node.js-applikation
- Användning av JSON för datatransmission
- Integration med OpenAI API för chatt-kompletteringar
Steg-för-steg-guide
Steg 1: Skapa API-mappen
För att säkerställa ren kod bör du skapa en särskild mapp för dina API-ändpunkter. I ditt React-projekt bör du skapa en ny undermapp med namnet API under katalogen pages.
Steg 2: Skapa filen chat.js
I den nyss skapade API-mappen, skapa en ny fil med namnet chat.js. Denna fil kommer att innehålla Node.js-koden som hanterar GET-förfrågan.
Steg 3: Implementera GET-hanteraren
Du måste definiera en GET-hanterare i filen chat.js. Denna hanterare kommer att ta emot inkommande förfrågningar på URL:en /api/chat. Det är viktigt att funktionen heter get eftersom det är ett krav för att det ska erkännas som en GET-hanterare i Astro.
Steg 4: Returnera ett enkelt svar
För tillfället kan du returnera ett enkelt JSON-svar. Använd new Response() och initiera svaret med JSON.stringify() för att serialisera ett objekt som innehåller en answer-egenskap. För det här första testsvaret kan du helt enkelt sätta "Hej".
Steg 5: Ange status och header
Förutom att returnera kroppen på svaret, kan du också lägga till statuskoden och headern. Ange status 200, vilket betyder att begäran lyckades, och definiera Content-Type som application/json för att se till att klienten känner igen svaret som JSON.
Steg 6: Testa ändpunkten i webbläsaren
När allt är konfigurerat kan du testa ändpunkten. Öppna din webbläsare och gå till din lokala utvecklingsmiljö genom att ange URL:en http://localhost:3000/api/chat. Du bör se svaret som du definierade i föregående steg.
Steg 7: Kontrollera korrekt retur
Om du anger URL:en och ser det korrekta JSON-svaret i webbläsaren innebär det att din GET-hanterare fungerar. Denna enkla implementation kommer att vara grunden för framtida utvidgningar, där du kommer att integrera OpenAI API för chatt-kompletteringar.
Steg 8: Utöka till OpenAI API
I en framtida session kommer vi att utöka den redan implementerade ändpunkten för att hämta chatt-kompletteringar från OpenAI API. Den aktuella ändpunkten kommer dock redan att ge dig den grundläggande förståelsen för HTTP-interaktioner via API:n.
Sammanfattning
I den här handledningen har du lärt dig hur du kan skapa en enkel GET-ändpunkt för din Node.js-applikation som returnerar JSON-svar. Denna grundläggande implementering utgör grunden för framtida utökningar, särskilt för integreringen av OpenAI API, som vi kommer att behandla i nästa video.
Vanliga frågor
Hur skapar jag en undermapp i mitt projekt?Du kan skapa en undermapp i ditt projekt genom att skapa en ny mapp med namnet API i katalogen pages.
Varför är det viktigt att min GET-hanterare heter get?Hos Astro är namnet på hanteraren avgörande för att känna igen motsvarande HTTP-förfrågningar.
Hur testar jag min nya ändpunkt?Ange URL:en http://localhost:3000/api/chat i din webbläsare för att kontrollera svaret från din GET-hanterare.
Vad kommer att behandlas i nästa video?I nästa video kommer vi att utöka den nuvarande ändpunkten för att hämta chatt-kompletteringar från OpenAI API.