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