Zodはnext.jsでタイプセーフAPIルーティングを?qū)g裝できます最初に、要求と応答のスキーマを定義し、次に検証を使用して高次関數(shù)を介してタイプを検証して注入し、最後にこのカプセル化をルーティングで使用して、入力と出力が確認(rèn)されていることを確認(rèn)します。スキーマを再利用して、一貫性を確保するためにフロントエンドタイプを生成することもできます。 1.スキーマ検証要求本體、クエリパラメーター、応答構(gòu)造を定義します。 2. [Validation関數(shù)]を作成して、リクエストを自動(dòng)的に解析して入力します。 3.この関數(shù)をAPIルーティングに適用して、フルリンクタイプの安全性を?qū)g現(xiàn)します。 4.オプションで応答本體を検証し、ツール機(jī)能をカプセル化します。 5.フロントエンドは、ZODによって生成されたタイプを直接インポートして、フロントエンドとバックエンドのタイプが一貫していることを確認(rèn)し、それにより開(kāi)発エクスペリエンスとプロジェクトの品質(zhì)を改善します。

next.jsはフルスタックアプリケーションの構(gòu)築を簡(jiǎn)単にしますが、デフォルトでは、APIルーティングは弱いタイプです。リクエストボディの解析、クエリパラメーター、または応答形式で簡(jiǎn)単にエラーを作成できます。 ZODと組み合わせて、コンパイル時(shí)間チェックとリクエストから応答までの自動(dòng)プロンプトを使用して、完全にタイプセーフAPIルーティングを?qū)g裝できます。

次に、next.jsでZODを使用してタイプセーフAPIルーティングを?qū)g裝する実用的な方法です。

creatsリクエストと応答を定義するスキーマ

ZODのコアは、検証可能なデータ構(gòu)造を定義することです。 APIルーティングの場(chǎng)合、通常は確認(rèn)する必要があります。

• クエリパラメーター（ query ）
• ボディ（ body ）をリクエストする
• response

 // lib/schemas/userschema.ts
'zod'から{z}をインポートします。

const const createusschema = z.object（{{
  ボディ：Z.Object（{
    名前：z.string（）。min（1）、
    電子メール：Z.String（）。電子メール（）、
  }）、
  クエリ：z.object（{
    apikey：z.string（）。min（1）、
  }）。optional（）、
}）;

Export Type createUserInput = z.infer <typeof createUsschema>;

このスキーマは、Post /api/usersが必要とする構(gòu)造を定義します。

？§タイプセーフAPIプロセッサを作成します

高次関數(shù)をカプセル化し、自動(dòng)的に解析し、 req.bodyとreq.queryを入力します。

 // lib/api/handler.ts
'next'から{nextapirequest、nextapiresponse}をインポートします。
'zod'から{zodschema、zoderror}をインポートします。

タイプハンドラー<t> =（
  req：nextapirequest＆{body：t [&#39;body&#39;];クエリ：t [&#39;query&#39;]}、
  Res：nextapiresponse
）=>約束<void> |空所;

Validation <t extends {body？：any;クエリ？：任意の}>（
  スキーマ：Zodschema <t>、
  ハンドラー：ハンドラー<t>
）{
  asyncを返す（req：nextapirequest、res：nextapiresponse）=> {
    試す {
      const data = schema.parse（{
        ボディ：req.method！== &#39;get&#39;？ req.body：未定義、
        クエリ：req.Query、
      }）;

      返品ハンドラー（任意のようにreq、res）;
    } catch（error）{
      if（zoderrorのエラーインスタンス）{
        Restr.Status（400）.json（{
          エラー：「検証が失敗した」、
          詳細(xì)：error.errors、
        }）;
      }
      return res.status（500）.json（{error： &#39;internal server error&#39;}）;
    }
  };
}

これはwithValidation機(jī)能を備えています。

• 入力を確認(rèn)します
• タイプレベルで正しいbodyとqueryタイプを「注入」
• ZODエラーをキャッチし、400を返します

？実際の使用：タイプセーフAPIルーティング

// pages/api/users.ts
'next'から{nextapirequest、nextapiresponse}をインポートします。
'@/lib/api/handler'から{withvalidation}をインポートします。
'@/lib/schemas/userschema'から{createUsschema}をインポートします。

Validationを使用してデフォルトをエクスポートします（
  CreateUsschema、
  Async関數(shù)CreateUser（
    req：nextapirequest＆{body：{name：string;電子メール：文字列}}、
    Res：nextapiresponse
  ）{
    const {name、email} = req.body;

    //ここに安全を入力：名前と電子メールはZODによって文字列であることが保証されています
    //データベースに安全に挿入できます...

    RETRES RES.STATUS（201）.JSON（{
      ID： '123'、
      名前、
      メール、
    }）;
  }
）;

今：

• フロントエンドがname: null 、zodによって拒否されます
• VSコードでは、 req.body.完全な自動(dòng)完成があります
• req.body.phoneへのアクセスはエラーを報(bào)告します（スキーマが定義されていない限り）

？オプション：統(tǒng)一された応答形式の応答検証

さらに進(jìn)むと、出力を確認(rèn)して、敏感なフィールドの予期しない返品を防ぐこともできます。

 const createresponsschema = z.object（{
  ID：Z.String（）、
  名前：Z.String（）、
  メール：Z.String（）、
}）;

// const result = {id： '123'、name、email};
const parsed = createresponseschema.parse（result）; //出力構(gòu)造が正しいことを確認(rèn)してくださいRestr.Status（201）.JSON（解析）;

validResponse(schema, data)ツール機(jī)能をカプセル化することもできます。

？ヒント：フロントエンドタイプの再利用

ZODスキーマはタイプスクリプトタイプを生成できるため、フロントエンドは直接インポートできます。

 //フロントエンドコンポーネント
'@/lib/schemas/userschema'からtype {createUserInput}をインポートします。

constデータ：createUserInput ['body'] = {
  名前：「アリス」、
  電子メール：「alice@example.com」、
}; //タイプはまったく同じであり、バックエンドの変化フィールドについて心配する必要はありません

基本的にそれだけです。少量のZODカプセル化を使用すると、next.js APIルーティングを取得できます。

• リクエストボディ/クエリパラメーターの自動(dòng)検証
• フルリンクタイプの安全性
• 開(kāi)発エクスペリエンスの向上（自動(dòng)完了、早期エラーレポート）
• ランタイムエラーを減らします

複雑ではありませんが、プロジェクトの品質(zhì)を大幅に向上させることができます。

以上がZODを使用したnext.jsのタイプセーフAPIルートの詳細(xì)內(nèi)容です。詳細(xì)については、PHP 中國(guó)語(yǔ) Web サイトの他の関連記事を參照してください。