axios-zod-gen

---

When the API response does not match returnSchema, the expected status code is 400. However, since the status code cannot be modified through Axios interceptors, the library is being deprecated.

---

This package allows you to easily create strongly-typed API functions with runtime validation. Which is based on Axios and Zod

Features

• Typed API functions: Automatically generates Axios functions based on your configuration.
• Zod Integration: Supports Zod schemas for path parameters, query parameters, request bodies, and response validation.
• Customizable: Use a default or custom Axios instance for your API requests.

Usage

Generating API Functions

You can generate multiple API functions based on a configuration object by using initApiFunctions. This allows you to create a set of typed and validated API calls.

1import { initApiFunctions } from 'axios-zod-gen';
2import { z } from 'zod';
3
4const configs = {
5  getUser: {
6    method: 'get',
7    url: '/user/:id',
8    pathParamSchema: z.object({ id: z.string() }),
9    returnSchema: z.object({ id: z.string(), name: z.string() }),
10  },
11  updateUser: {
12    method: 'post',
13    url: '/user/:id',
14    pathParamSchema: z.object({ id: z.string() }),
15    bodySchema: z.object({ name: z.string() }),
16  },
17};
18
19const api = initApiFunctions(configs);
20
21// Usage:
22async function fetchUser() {
23  const response = await api.getUser({ id: '123' });
24  console.log(response.data); // { id: '123', name: 'John Doe' }
25}
26
27async function saveUser() {
28  const response = await api.updateUser({ id: '123', name: 'Jane Doe' });
29  console.log(response.data);
30}

Creating Individual API Functions

If you only need to create a single API function, you can use createApiFunction directly.

1import { createApiFunction } from 'axios-zod-gen';
2import { z } from 'zod';
3
4const getUser = createApiFunction({
5  method: 'get',
6  url: '/user/:id',
7  pathParamSchema: z.object({ id: z.string() }),
8  returnSchema: z.object({ id: z.string(), name: z.string() }),
9});
10
11// Usage:
12const user = await getUser({ id: '123' });
13console.log(user.data); // { id: '123', name: 'John Doe' }

License

This project is licensed under the MIT License.