У цьому посібнику ти навчишся, як додати кінцеву точку для сервісу чату у своєму застосунку Node.js. Наша мета - створити просту кінцеву точку GET для URL /api/chat, яка потім поверне відповідь клієнтові. Ця кінцева точка пізніше буде з'єднана з OpenAI API для генерації чатових автодоповнень. Давай безпосередньо розберемося та пройдемо необхідні кроки.
Головні відкриття
- Створення кінцевої точки GET у застосунку Node.js
- Використання JSON для передачі даних
- Інтеграція з OpenAI API для чатових автодоповнень
Поетапний підручник
Крок 1: Створення папки API
Для забезпечення чистого коду тобі слід створити спеціальну папку для кінцевих точок API. У своєму проекті React ти повинен створити нову підпапку під назвою API у каталозі pages.
Крок 2: Створення файлу chat.js
У папці API, щойно створеній, створи новий файл під назвою chat.js. Цей файл міститиме код Node.js, який оброблятиме запит GET.
Крок 3: Реалізація обробника GET
Тобі потрібно визначити обробник GET у файлі chat.js. Цей обробник буде обробляти вхідні запити на URL /api/chat. Важливо, щоб функція мала назву get, оскільки це необхідна умова для того, щоб її в Astro було визнано як обробник GET.
Крок 4: Виведення простої відповіді
На даний момент можеш повернути просту відповідь у форматі JSON. Для цього скористайся new Response() та ініціалізуй відповідь за допомогою JSON.stringify(), щоб серіалізувати об'єкт, який містить властивість відповіді. Для цієї першої тестової відповіді можеш просто вказати "Привіт".
Крок 5: Встановлення статусу та заголовка
Окрім тіла відповіді, можна також додати код статусу та заголовок. Встано статус 200, що означає успішний запит, і визнач тип контенту як application/json, щоб клієнт визначив відповідь як JSON.
Крок 6: Тестування кінцевої точки у браузері
Після налаштування можеш протестувати кінцеву точку. Відкрий свій браузер та перейди до свого локального середовища розробки, ввівши URL http://localhost:3000/api/chat. Ти повинен побачити відповідь, яку визначив у попередній фазі.
Крок 7: Перевірка правильного повернення
Якщо ти введеш URL та побачиш правильну JSON-відповідь у браузері, це означає, що твій обробник GET працює. Ця проста реалізація стане основою для майбутнього розширення, де ти інтегруєш OpenAI API для чатових автодоповнень.
Крок 8: Розширення до OpenAI API
На майбутній сесії ми розширимо вже реалізовану кінцеву точку, щоб отримувати чатові автодоповнення з OpenAI API. Проте поточна кінцева точка вже надасть тобі необхідне базове розуміння HTTP-взаємодій через API.
Підсумок
У цьому посібнику ти вивчив, як створити просту кінцеву точку GET для свого застосунку Node.js, яка повертає JSON-відповіді. Ця базова реалізація є основою для майбутніх розширень, особливо для інтеграції OpenAI API, про що ми говоритимемо у наступному відео.
Часті питання
Як створити підпапку у своєму проекті?Ти можеш створити підпапку у своєму проекті, створивши нову папку з назвою API у каталозі pages.
Чому важливо, щоб моя GET-функція мала назву get?У Astro ім'я обробника є ключовим для розпізнавання відповідного HTTP-запиту.
Як перевірити свою нову кінцеву точку?Введи URL http://localhost:3000/api/chat у свій браузер, щоб перевірити відповідь свого GET-обробника.
Про що буде наступне відео?У наступному відео ми розширимо поточну кінцеву точку, щоб отримувати чатові автодоповнення за допомогою OpenAI API.
