このチュートリアルでは、Node.jsアプリケーションにチャットサービスのエンドポイントを追加する方法を学びます。私たちの目標は、/api/chatというURLの簡単なGETエンドポイントを作成し、その後にクライアントに応答を返すことです。このエンドポイントは後でOpenAI APIと連携して、チャット補完を生成します。さあ、必要な手順について進んでみましょう。
主な学習ポイント
- Node.jsアプリケーションでGETエンドポイントを作成
- JSONを使用したデータ転送
- チャット補完のためのOpenAI APIとの統合
ステップバイステップガイド
ステップ1:APIフォルダーの作成
クリーンなコードを確保するために、APIエンドポイント用の特別なフォルダーを作成することをお勧めします。Reactプロジェクトでは、pagesディレクトリの下に名前がAPIの新しいサブフォルダーを作成してください。
ステップ2:chat.jsファイルの作成
作成したAPIフォルダー内にchat.jsという新しいファイルを作成してください。このファイルには、GETリクエストを処理するNode.jsコードが含まれます。
ステップ3:GETハンドラの実装
chat.jsファイル内にGETハンドラを定義する必要があります。このハンドラは、URL/api/chatへの着信リクエストを処理します。AstroでGETハンドラとして識別されるために、関数名をgetにすることが重要です。
ステップ4:簡単な応答の出力
一旦、簡単なJSON応答を返すことができます。これには、JSON.stringify()で応答を初期化し、"Hello"を含むanswerプロパティをシリアル化するオブジェクトを使います。
ステップ5:ステータスとヘッダーの設定
応答の本文だけでなく、ステータスコードとヘッダーも追加できます。ステータスを"200"に設定して、リクエストが成功したことを示し、Content-Typeをapplication/jsonに定義してクライアントが応答をJSONとして認識できるようにします。
ステップ6:ブラウザでエンドポイントをテスト
すべてをセットアップしたら、エンドポイントをテストできます。ブラウザを開いて、URL http://localhost:3000/api/chat に移動してください。前の段階で定義した応答を見るはずです。
ステップ7:正しい応答を確認
URLを入力して正しいJSON応答をブラウザで確認できる場合、GETハンドラが機能していることを意味します。この簡単な実装は、後の拡張の基礎となり、後でOpenAI APIをチャット補完のために統合する際に活用します。
ステップ8:OpenAI APIへの拡張
将来のセッションでは、OpenAI APIからチャット補完を取得するための既に実装されたエンドポイントを拡張します。ただし、現在のエンドポイントはAPIを介したHTTP相互作用の理解に必要な基本をすでに提供しています。
まとめ
このチュートリアルでは、Node.jsアプリケーションに簡単なGETエンドポイントを作成し、JSON応答を返す方法を学びました。この基本的な実装は、将来の拡張、特にOpenAI APIの統合の基礎となります。次のビデオで取り上げる予定です。
よくある質問
プロジェクト内にサブフォルダーを作成する方法は?pagesディレクトリ内に、APIという名前の新しいフォルダーを作成することでプロジェクト内にサブフォルダーを作成できます。
GETハンドラの名前がgetであることの重要性は?HTTPリクエストの対応関係を識別するために、Astroではハンドラの名前が重要です。
新しいエンドポイントをテストする方法は?ブラウザにURL http://localhost:3000/api/chat を入力すると、GETハンドラの応答を確認できます。
次のビデオでは何を取り上げる予定ですか?次のビデオでは、OpenAI APIからチャット補完を取得するために現在のエンドポイントを拡張する予定です。