Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add API response validation example to basic usage #3889

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -661,6 +661,32 @@ type User = z.infer<typeof User>;
// { username: string }
```

Validating an API response:

```ts
import { z } from "zod";

const userSchema = z.object({
id: z.number(),
username: z.string(),
email: z.string().email(),
});

type User = z.infer<typeof userSchema>;

async function getUserById(id: number) {
const response = await fetch(`/api/users/${id}`);
// data is untyped JSON response from the API
const data = await response.json();

// parse and validate the data against the schema to ensure it matches the expected shape
const user = userSchema.parse(data);

// user is now fully typed as { id: number, username: string, email: string }
return user;
}
```

## Primitives

```ts
Expand Down
Loading