02. Examples

1. Creating a path

const router = createRouter(Router(), { basePath: '/api' })

const users = router.path('/users')

users.handler({
	id: 'FindAllUsers',
	method: 'get',
	response: {
		200: z.array(
			z.object({
				name: z.string(),
				email: z.string().email(),
				age: z.number(),
			}),
		),
	},
	async resolver() {
		const users = await db.users.find()
		return {
			200: users,
		}
	},
})

---

2. Validations

IMPORTANT:

Request params and query are always string type since you can only get them from the request url. So, when you defining request.params and request.query schemas, you always need to defined z.string(). After that, you can type cast the parsed string as you wanted.

2.1 Params

const users = router.path('/users')

const usersId = users.path('/:id')
usersId.handler({
	id: 'FindOneUserById',
	method: 'get',
	request: {
		params: z.object({
			id: z
				.string()
				.min(1, { message: 'Id is required.' })
				.regex(/^\d+$/g, { message: 'Id should only be numeric.' })
				.transform((v) => Number(v)),
		}),
	},
	response: {
		200: z.object({
			name: z.string(),
			email: z.string().email(),
		}),
	},
	async resolver({ ctx }) {
		const { id } = ctx.params
		const user = await db.users.findOne(id)
		return {
			200: user,
		}
	},
})

2.2 Params

const users = router.path('/users')

users.handler({
	id: 'FindAllUsers',
	method: 'get',
	request: {
		query: z.object({
			limit: z
				.string()
				.default('10')
				.transform((v) => Number(v)),
			offset: z
				.string()
				.default('0')
				.transform((v) => Number(v)),
		}),
	},
	response: {
		200: z.array(
			z.object({
				name: z.string(),
				email: z.string().email(),
			}),
		),
	},
	async resolver({ ctx }) {
		const { limit, offset } = ctx.query
		const users = await db.users.find({ take: limit, skip: offset })
		return {
			200: users,
		}
	},
})

2.3 Body

const users = router.path('/users')

users.handler({
	id: 'CreateNewUser',
	method: 'post',
	request: {
		body: z.object({
			name: z.string().min(1, { message: 'name is required.' }),
			email: z.string().email({ message: 'wrong email format.' }),
		}),
	},
	response: {
		200: z.object({
			name: z.string(),
			email: z.string().email(),
		}),
	},
	async resolver({ ctx }) {
		const { name, email } = ctx.body
		const user = await db.users.create({ name, email })
		return {
			200: user,
		}
	},
})

---