API Routesを使用してフォームを作成する方法

フォームを使用することで、ウェブアプリケーション内でデータを作成および更新できます。Next.jsはAPI Routesを使用したデータミューテーションを処理する強力な方法を提供しています。このガイドでは、サーバー上でフォーム送信を処理する方法について説明します。

Server Forms

サーバー上でフォーム送信を処理するには、データを安全にミューテーションするAPIエンドポイントを作成します。

pages/api/submit.ts

TypeScript

import type { NextApiRequest, NextApiResponse } from 'next'
 
export default async function handler(
  req: NextApiRequest,
  res: NextApiResponse
) {
  const data = req.body
  const id = await createItem(data)
  res.status(200).json({ id })
}

その後、イベントハンドラーを使用してクライアントからAPI Routeを呼び出します。

pages/index.tsx

TypeScript

import { FormEvent } from 'react'
 
export default function Page() {
  async function onSubmit(event: FormEvent<HTMLFormElement>) {
    event.preventDefault()
 
    const formData = new FormData(event.currentTarget)
    const response = await fetch('/api/submit', {
      method: 'POST',
      body: formData,
    })
 
    // 必要に応じてレスポンスを処理する
    const data = await response.json()
    // ...
  }
 
  return (
    <form onSubmit={onSubmit}>
      <input type="text" name="name" />
      <button type="submit">Submit</button>
    </form>
  )
}

補足：

API RoutesはCORSヘッダーを指定しないため、デフォルトではsame-originのみです。

API Routesはサーバー上で実行されるため、環境変数を使用して機密値（APIキーなど）を使用でき、クライアントに露出させません。これはアプリケーションのセキュリティにとって重要です。

フォーム検証

基本的なクライアント側のフォーム検証には、requiredやtype="email"などのHTML検証を使用することをお勧めします。

より高度なサーバー側の検証については、zodなどのスキーマ検証ライブラリを使用して、データをミューテーションする前にフォームフィールドを検証できます。

pages/api/submit.ts

TypeScript

import type { NextApiRequest, NextApiResponse } from 'next'
import { z } from 'zod'
 
const schema = z.object({
  // ...
})
 
export default async function handler(
  req: NextApiRequest,
  res: NextApiResponse
) {
  const parsed = schema.parse(req.body)
  // ...
}

エラーハンドリング

React stateを使用して、フォーム送信が失敗したときにエラーメッセージを表示できます。

pages/index.tsx

TypeScript

import React, { useState, FormEvent } from 'react'
 
export default function Page() {
  const [isLoading, setIsLoading] = useState<boolean>(false)
  const [error, setError] = useState<string | null>(null)
 
  async function onSubmit(event: FormEvent<HTMLFormElement>) {
    event.preventDefault()
    setIsLoading(true)
    setError(null) // 新しいリクエスト開始時に前のエラーをクリア
 
    try {
      const formData = new FormData(event.currentTarget)
      const response = await fetch('/api/submit', {
        method: 'POST',
        body: formData,
      })
 
      if (!response.ok) {
        throw new Error('Failed to submit the data. Please try again.')
      }
 
      // 必要に応じてレスポンスを処理する
      const data = await response.json()
      // ...
    } catch (error) {
      // ユーザーに表示するエラーメッセージをキャプチャ
      setError(error.message)
      console.error(error)
    } finally {
      setIsLoading(false)
    }
  }
 
  return (
    <div>
      {error && <div style={{ color: 'red' }}>{error}</div>}
      <form onSubmit={onSubmit}>
        <input type="text" name="name" />
        <button type="submit" disabled={isLoading}>
          {isLoading ? 'Loading...' : 'Submit'}
        </button>
      </form>
    </div>
  )
}

ローディング状態の表示

React stateを使用して、フォームがサーバー上で送信されているときにローディング状態を表示できます。

pages/index.tsx

TypeScript

import React, { useState, FormEvent } from 'react'
 
export default function Page() {
  const [isLoading, setIsLoading] = useState<boolean>(false)
 
  async function onSubmit(event: FormEvent<HTMLFormElement>) {
    event.preventDefault()
    setIsLoading(true) // リクエスト開始時にローディングをtrueに設定
 
    try {
      const formData = new FormData(event.currentTarget)
      const response = await fetch('/api/submit', {
        method: 'POST',
        body: formData,
      })
 
      // 必要に応じてレスポンスを処理する
      const data = await response.json()
      // ...
    } catch (error) {
      // 必要に応じてエラーを処理する
      console.error(error)
    } finally {
      setIsLoading(false) // リクエスト完了時にローディングをfalseに設定
    }
  }
 
  return (
    <form onSubmit={onSubmit}>
      <input type="text" name="name" />
      <button type="submit" disabled={isLoading}>
        {isLoading ? 'Loading...' : 'Submit'}
      </button>
    </form>
  )
}

リダイレクト

ミューテーション後に別のルートにユーザーをリダイレクトする場合、絶対URLまたは相対URLにredirectできます。

pages/api/submit.ts

TypeScript

import type { NextApiRequest, NextApiResponse } from 'next'
 
export default async function handler(
  req: NextApiRequest,
  res: NextApiResponse
) {
  const id = await addPost()
  res.redirect(307, `/post/${id}`)
}