如何使用 API Routes 创建表单

表单使你能够在 Web 应用程序中创建和更新数据。Next.js 提供了一种使用 API Routes 处理数据变更的强大方式。本指南将引导你了解如何在服务器上处理表单提交。

服务器表单

要在服务器上处理表单提交，请创建一个安全地变更数据的 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 标头，这意味着它们默认情况下仅限同源。

由于 API Routes 在服务器上运行，我们能够通过环境变量使用敏感值（如 API 密钥），而不会将它们暴露给客户端。这对于应用程序的安全性至关重要。

表单验证

我们建议使用 HTML 验证，如 required 和 type="email"，进行基本的客户端表单验证。

对于更高级的服务器端验证，你可以使用像 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>
  )
}

重定向

如果你想在变更后将用户重定向到不同的路由，可以使用 redirect 重定向到任何绝对或相对 URL：

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}`)
}