路由处理器、Request/Response 类型
为 Express 路由处理器指定类型:参数、查询参数和 JSON 请求体;使用 res.json 和可复用的 DTO 发送带类型的响应。
路由处理器、Request/Response 类型 是 CoddyKit 上的免费 TypeScript Academy 课时。 这是第 1 节课,共 3 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 TypeScript Academy 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 TypeScript Academy 课程共包含 3 节课。
入门
目标:使用严格类型连接一个小型 Express API。您将为路由参数、查询和JSON 请求体指定类型,然后使用 res.json 返回带类型的 JSON。
- DTO 接口
Request<P, Res, Body, Q>- 带类型的
res.json
服务器设置
初始化 Express 并启用JSON 解析。使用 Request/Response,让健康检查端点保持简洁并具有类型。
import express, { Request, Response } from "express"
const app = express()
app.use(express.json())
app.get("/", (_req: Request, res: Response) => {
res.type("text/plain").send("OK")
})
app.listen(3000, () => console.log("http://localhost:3000"))参数与查询
明确指定每个位置的类型:参数、查询和 ResBody。自动补全有助于避免拼写错误。
import { Request, Response } from "express"
type Params = { id: string }
type Query = { verbose?: "1" | "0" }
type ResBody = { id: string; name: string; details?: string }
export function getUser(req: Request<Params, ResBody, unknown, Query>, res: Response<ResBody>) {
const { id } = req.params
const { verbose } = req.query
const body: ResBody = { id, name: "Ada", details: verbose === "1" ? "Loves math" : undefined }
return res.status(200).json(body)
}带类型的 body 与响应
为 POST/PUT 标注 body,并为响应指定类型。DTO 还可以兼作文档。
import { Request, Response } from "express"
type CreateUserBody = { name: string }
type CreateUserRes = { id: string; name: string }
export function createUser(req: Request<{}, CreateUserRes, CreateUserBody>, res: Response<CreateUserRes>) {
const { name } = req.body
const result: CreateUserRes = { id: "u_1", name }
return res.status(201).json(result)
}连接路由
组合小型的带类型处理程序。路由参数通过匹配模板进行验证(例如 :id)。
import express from "express"
import { getUser } from "./getUser"
import { createUser } from "./createUser"
const app = express()
app.use(express.json())
app.get("/users/:id", getUser)
app.post("/users", createUser)
app.listen(3000, () => console.log("http://localhost:3000"))提示
提示:
- 让 DTO 保持精简,并在多个处理程序之间复用。
- 对于受约束的查询值,优先使用联合字面量。
- 返回精确的状态码和带类型的 JSON。
Express 类型检查
快速检查:如何为包含参数和 JSON 请求体的 Express 处理程序指定类型?
回顾
回顾:您为路由参数、查询、请求体和响应指定了类型。同一种模式也适用于路由器和中间件。
常见问题解答
「路由处理器、Request/Response 类型」课时是免费的吗?
是的 — 「路由处理器、Request/Response 类型」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 TypeScript Academy 课程的其余内容,请升级到 CoddyKit PRO。 TypeScript Academy 课程共包含 3 节课。
「路由处理器、Request/Response 类型」这节课中我会学到什么?
为 Express 路由处理器指定类型:参数、查询参数和 JSON 请求体;使用 res.json 和可复用的 DTO 发送带类型的响应。 你通过在浏览器中直接运行的动手代码来练习 TypeScript Academy,全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 TypeScript Academy 需要有经验吗?
无需任何先前经验。CoddyKit 上的 TypeScript Academy 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 1 节课,共 3 节。
「路由处理器、Request/Response 类型」课时需要多长时间?
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。
我能在这节 TypeScript Academy 课中编写并运行代码吗?
能。每节 TypeScript Academy 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。
此课程中的所有课时
- 路由处理器、Request/Response 类型
- 使用 zod 进行模式校验并推断 TS 类型
- 错误中间件与结果类型