🚀

【Next.js和訳】API Routes/Response Helpers

1 min read

この記事について

株式会社 UnReact はプロジェクトの一環としてNext.js ドキュメントの和訳を行っています。

この記事は、API Routes/Response Helpersの記事を和訳したものです。

記事内で使用する画像は、公式ドキュメント内の画像を引用して使用させていただいております。

Response Helpers

レスポンス(res)には、開発者の使い勝手を向上させ、新しいAPIエンドポイントを作成するスピードを上げるためのExpress.jsのようなメソッド群が含まれていますので、次の例をご覧ください。

export default function handler(req, res) {
  res.status(200).json({ name: 'Next.js' })
}

含まれるヘルパーは以下の通りです。

  • res.status(code) - ステータスコードを設定する関数です。codeは有効なHTTPステータスコードでなければなりません。
  • res.json(body) - JSON形式の応答を送信します。bodyシリアライズ可能なオブジェクトでなければなりません。
  • res.send(body) - HTTPレスポンスを送信します。bodyは、stringobjectBufferのいずれかです。
  • res.redirect([status,] path) - 指定されたパスまたはURLにリダイレクトします。statusは有効なHTTPステータスコードでなければなりません。指定されていない場合、statusのデフォルトは "307" "Temporary redirect" です。

タイプを使った例を見るには、TypeScriptのドキュメントをご覧ください。

Discussion

ログインするとコメントできます