本文へ移動
Senri

ルートの表

defineRoutes()・endpoint()・mergeRoutes() で、型を持ったルートの表を作る

ルートを表にまとめると、ルートの型(パス・パラメーター・スキーマ・ハンドラーの戻り値)を持ったまま、ファイルの外に出せます。その型から、クライアント・テスト・OpenAPI を作れます。

routes.ts
import { , ,  } from "@senrijs/senri";
import {  } from "zod";

// キーは "メソッド /パス"。パラメーターは、キーから型が付く
export const  = ({
    "GET /users/:id": ({  }) => ({  }),
    // スキーマを付けるルートは、endpoint(schemas, handler) で包む
    "POST /users": ({ : .({ : .() }) }, (, ) => ({ : .("body"). })),
});

// 前置きは 2 段で書く。前置きのパラメーターにも型が付く
export const  = ("/orgs/:orgId")({
    "GET /": ({  }) => `org ${}`,                   // GET /orgs/:orgId
    "GET /members/:memberId": ({ ,  }) => ({ ,  }),
});

// 表を合わせる(同じキーが 2 つあればエラー)
export const  = (, );
export type  = typeof ;
index.ts
import {  } from "@senrijs/senri";
import {  } from "./routes.ts";

const  = ();
.();

endpoint()

endpoint(options, handler) の options には、次のものを書けます。

キー中身
params・query・body確かめるスキーマ(バリデーション)
useこのルートだけのミドルウェア(ルートごとに付ける)
response・responses返す本文のスキーマ(200 と、status ごと)。クライアントの型と OpenAPI に使う
bodyTypeフォームで受けるルートは "form"(OpenAPI に使う)
openapiOpenAPI に入れる summary・tags など

決まり

  • 前置きは / で始め、/ で終わらないように書きます("/users")
  • 表の全部のルートにミドルウェアを付けるときは、defineRoutes("/admin", { use: [auth] })({ ... }) と書きます
  • c.get() に型を付けるときは、前置きと一緒にアプリの型を渡します: defineRoutes<"/admin", Vars>("/admin")({ ... })
  • パスの書き方の確認と、同じルートを 2 回登録していないかの確認は、app.routes() に渡したときに、app.get() と同じく行います

このページの内容