In deze zelfstudie zul je leren hoe je een eindpunt voor de chat-service aan je Node.js-applicatie kunt toevoegen. Ons doel is om een eenvoudig GET-eindpunt voor de URL /api/chat te creëren, dat vervolgens een antwoord terugstuurt naar de client. Dit eindpunt zal later verbonden worden met de OpenAI API om chat-aanvullingen te genereren. Laten we direct beginnen en de benodigde stappen doornemen.
Belangrijkste inzichten
- Creëren van een GET-eindpunt in een Node.js-applicatie
- Gebruik van JSON voor gegevensoverdracht
- Integratie met de OpenAI API voor chat-aanvullingen
Stapsgewijze handleiding
Stap 1: Aanmaken van de API-map
Om een schone code te garanderen, moet je een speciale map voor je API-eindpunten aanmaken. In je React-project moet je onder de pages-map een nieuwe submap met de naam API aanmaken.
Stap 2: Aanmaken van het bestand chat.js
In de zojuist aangemaakte API-map maak je een nieuw bestand genaamd chat.js aan. Dit bestand bevat de Node.js-code die de GET-request afhandelt.
Stap 3: Implementatie van de GET-handler
Je moet een GET-handler definiëren in het bestand chat.js. Deze handler zal inkomende verzoeken naar de URL /api/chat verwerken. Het is belangrijk dat de functie de naam get heeft, aangezien dit een vereiste is om door Astro als GET-handler herkend te worden.
Stap 4: Uitvoeren van een eenvoudig antwoord
Voor nu kun je een eenvoudig JSON-antwoord teruggeven. Gebruik hiervoor new Response() en initialiseer de Response met JSON.stringify() om een object te serialiseren dat een eigenschap 'answer' bevat. Voor dit eerste testantwoord kun je eenvoudigweg "Hallo" instellen.
Stap 5: Instellen van de status en de koptekst
Naast het retourneren van de body van de Response, kun je ook de statuscode en de koptekst toevoegen. Stel de status in op 200, wat betekent dat het verzoek succesvol was, en definieer de Content-Type als application/json om ervoor te zorgen dat de client het antwoord als JSON herkent.
Stap 6: Testen van het eindpunt in de browser
Nadat alles is opgezet, kun je het eindpunt testen. Open je browser en ga naar je lokale ontwikkelingsomgeving door de URL http://localhost:3000/api/chat in te voeren. Je zou het antwoord dat je in de vorige fase hebt gedefinieerd moeten zien.
Stap 7: Controleren van de juiste uitvoer
Als je de URL invoert en het juiste JSON-antwoord in de browser ziet, betekent dit dat je GET-handler werkt. Deze eenvoudige implementatie zal de basis vormen voor latere uitbreidingen, waarbij je de OpenAI API zult integreren voor de chat-aanvullingen.
Stap 8: Uitbreiden naar OpenAI API
In een toekomstige sessie zullen we het reeds geïmplementeerde eindpunt uitbreiden om chat-aanvullingen van de OpenAI API op te halen. Het huidige eindpunt zal je echter al de nodige basiskennis geven voor de HTTP-interacties via de API.
Samenvatting
In deze zelfstudie heb je geleerd hoe je een eenvoudig GET-eindpunt voor je Node.js-applicatie kunt maken dat JSON-antwoorden terugstuurt. Deze basisimplementatie vormt de basis voor toekomstige uitbreidingen, met name voor de integratie van de OpenAI API, die we in de volgende video zullen behandelen.
Veelgestelde vragen
Hoe maak ik een submap in mijn project?Je kunt een submap in je project aanmaken door een nieuwe map met de naam API in de pages-map aan te maken.
Waarom is het belangrijk dat mijn GET-handler get heet?In Astro is de naam van de handler cruciaal voor de herkenning van het overeenkomstige HTTP-verzoek.
Hoe kan ik mijn nieuwe eindpunt testen?Voer de URL http://localhost:3000/api/chat in je browser in om het antwoord van je GET-handler te controleren.
Wat wordt behandeld in de volgende video?In de volgende video zullen we het huidige eindpunt uitbreiden om chat-aanvullingen van de OpenAI API op te halen.