Skip to content

Commit dac4672

Browse files
committed
refactor: rename zodValidation to zodValidator
1 parent 65e5804 commit dac4672

File tree

5 files changed

+18
-18
lines changed

5 files changed

+18
-18
lines changed

docs/guides/getting-started.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ JSDoc 注释说明:
231231
```typescript
232232
import express from "express";
233233
// [!code ++:2]
234-
import { validateRequest } from "api-morph/express";
234+
import { zodValidator } from "api-morph/express";
235235
import { UpdateUserDto, UserIdDto } from "./schema";
236236

237237
const app = express();
@@ -247,7 +247,7 @@ app.put("/api/users/:id", (req, res) => { // [!code --]
247247
// [!code ++:4]
248248
app.put(
249249
"/api/users/:id",
250-
validateRequest({ params: UserIdDto, body: UpdateUserDto }),
250+
zodValidator({ params: UserIdDto, body: UpdateUserDto }),
251251
(req, res) => {
252252
const { id } = req.params;
253253
const { email, username } = req.body;
@@ -268,9 +268,9 @@ app.listen(port, () => {
268268
269269
### 这一步发生了什么?
270270
271-
通过集成 `validateRequest` 中间件,我们可以利用 Zod 对请求参数进行校验,这在真实的后端项目中几乎是必须的步骤。如果你不使用 api-morph,也会通过其他的方式实现这个功能。
271+
通过集成 `zodValidator` 中间件,我们可以利用 Zod 对请求参数进行校验,这在真实的后端项目中几乎是必须的步骤。如果你不使用 api-morph,也会通过其他的方式实现这个功能。
272272
273-
**api-morph 的核心理念是尽可能利用已有的代码,分析它,然后自动推断出必要的信息。** 当你使用 `validateRequest` 后,api-morph 会分析它然后自动生成对应的请求参数文档。
273+
**api-morph 的核心理念是尽可能利用已有的代码,分析它,然后自动推断出必要的信息。** 当你使用 `zodValidator` 后,api-morph 会分析它然后自动生成对应的请求参数文档。
274274
275275
具体来说:
276276
- **自动验证路径参数**:`params: UserIdDto` 会验证 URL 中的 `:id` 参数
@@ -286,7 +286,7 @@ app.listen(port, () => {
286286
287287
```typescript
288288
import express from "express";
289-
import { validateRequest } from "api-morph/express";
289+
import { zodValidator } from "api-morph/express";
290290
import { UpdateUserDto, UserIdDto } from "./schema"; // [!code --]
291291
import { UpdateUserDto, UpdateUserVo, UserIdDto } from "./schema"; // [!code ++]
292292

@@ -303,7 +303,7 @@ app.use(express.json());
303303
*/
304304
app.put(
305305
"/api/users/:id",
306-
validateRequest({ params: UserIdDto, body: UpdateUserDto }),
306+
zodValidator({ params: UserIdDto, body: UpdateUserDto }),
307307
(req, res) => {
308308
const { id } = req.params;
309309
const { email, username } = req.body;
@@ -337,9 +337,9 @@ app.listen(port, () => {
337337
338338
```typescript
339339
import express from "express";
340-
import { validateRequest } from "api-morph/express"; // [!code --]
340+
import { zodValidator } from "api-morph/express"; // [!code --]
341341
import { generateDocument } from "api-morph"; // [!code ++]
342-
import { setupSwaggerUI, validateRequest } from "api-morph/express"; // [!code ++]
342+
import { setupSwaggerUI, zodValidator } from "api-morph/express"; // [!code ++]
343343
import { UpdateUserDto, UpdateUserVo, UserIdDto } from "./schema";
344344

345345
const app = express();
@@ -354,7 +354,7 @@ app.use(express.json());
354354
*/
355355
app.put(
356356
"/api/users/:id",
357-
validateRequest({ params: UserIdDto, body: UpdateUserDto }),
357+
zodValidator({ params: UserIdDto, body: UpdateUserDto }),
358358
(req, res) => {
359359
const { id } = req.params;
360360
const { email, username } = req.body;

docs/guides/working-principles.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ app.get("/api/users/:id", (req, res) => {
125125
::: code-group
126126

127127
```typescript [index.ts]
128-
import { validateRequest } from "api-morph/express";
128+
import { zodValidator } from "api-morph/express";
129129
import express from "express";
130130
import { UserIdDto } from "./schema";
131131

@@ -136,7 +136,7 @@ const app = express();
136136
*/
137137
app.get(
138138
"/api/users/:id",
139-
validateRequest({
139+
zodValidator({
140140
params: UserIdDto,
141141
}),
142142
(req, res) => {},
@@ -228,7 +228,7 @@ app.get('/api/users', getUserList);
228228

229229
- **HTTP 方法**:从路由定义中自动识别(如 `app.get()``app.post()` 等)
230230
- **API 路径**:从路由路径中提取并转换为 OpenAPI 格式(如 `/users/:id``/users/{id}`
231-
- **请求参数**:从 `validateRequest` 中间件中提取参数验证规则
231+
- **请求参数**:从 `zodValidator` 中间件中提取参数验证规则
232232
- `params`:路径参数
233233
- `query`:查询参数
234234
- `body`:请求体参数
@@ -264,7 +264,7 @@ const openapi = await generateDocument(
264264
* @operationId createUserV2 // 👈 覆盖自动生成的 operationId
265265
* @summary 创建新用户
266266
*/
267-
app.get('/api/users', validateRequest({ // 👈 代码分析器:GET /api/users
267+
app.get('/api/users', zodValidator({ // 👈 代码分析器:GET /api/users
268268
body: UserCreateDto
269269
}), createUser);
270270

src/express/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@
33
* @module express
44
*/
55

6-
export * from "./middlewares/zodValidation";
6+
export * from "./middlewares/zodValidator";
77
export * from "./swagger";
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ const defaultErrorHandler: ErrorRequestHandler = (error, _req, res) => {
6969
/**
7070
* 创建类型安全的 Zod 校验中间件
7171
*/
72-
export function validateRequest<
72+
export function zodValidator<
7373
TParams extends ZodObject = ZodObject,
7474
TQuery extends ZodObject = ZodObject,
7575
TBody extends ZodObject = ZodObject,

src/parsers/OpenAPIParser.test.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ const app = express()
260260
* @response 200 {@link UserVo} 获取用户信息成功
261261
* @response 404 {@link UserNotFoundVo} 用户不存在
262262
*/
263-
app.get("/api/users/:id", validateRequest({
263+
app.get("/api/users/:id", zodValidator({
264264
params: UserIdDto
265265
}), (req, res) => {})
266266
@@ -271,7 +271,7 @@ app.get("/api/users/:id", validateRequest({
271271
* @response 200 {@link UpdateUserVo} 更新用户信息成功
272272
* @response 404 {@link UserNotFoundVo} 用户不存在
273273
*/
274-
app.put("/api/users/:id", validateRequest({
274+
app.put("/api/users/:id", zodValidator({
275275
params: UserIdDto,
276276
body: UpdateUserDto
277277
}), (req, res) => {})`,
@@ -307,7 +307,7 @@ const app = express()
307307
* @response 200 {@link UserVo} 获取用户信息成功
308308
* @response 404 {@link UserNotFoundVo} 用户不存在
309309
*/
310-
app.get("/api/users/:id", validateRequest({
310+
app.get("/api/users/:id", zodValidator({
311311
params: UserIdDto
312312
}), (req, res) => {})`,
313313
);

0 commit comments

Comments
 (0)