Zodios

typescript http client and server with zod validation

Node.js framework
ecyrbe/zodioswww.zodios.org/@zodios/core

README

Zodios

Zodios logo

Zodios is a typescript api client and an optional api server with auto-completion features backed by axios and zod and express
Documentation


What is it ?


It's an axios compatible API client and an optional expressJS compatible API server with the following features:  
  
- really simple centralized API declaration
- typescript autocompletion in your favorite IDE for URL and parameters
- typescript response types
- parameters and responses schema thanks to zod
- response schema validation
- powerfull plugins like fetch adapter or auth automatic injection
- all axios features available
- @tanstack/query wrappers for react and solid (vue, svelte, etc, soon)
- all expressJS features available (middlewares, etc.)

  
Table of contents:

- What is it ?
- Install
  - Client and api definitions :
  - Server :
- How to use it on client side ?
  - Declare your API with zodios
  - API definition format
- Full documentation
- Ecosystem
- Roadmap
- Dependencies

Install


Client and api definitions :


  1. ```bash
  2. > npm install @zodios/core
  3. ```

or

  1. ```bash
  2. > yarn add @zodios/core
  3. ```

Server :

  
  1. ```bash
  2. > npm install @zodios/core @zodios/express
  3. ```

or

  1. ```bash
  2. > yarn add @zodios/core @zodios/express
  3. ```

How to use it on client side ?


For an almost complete example on how to use zodios and how to split your APIs declarations, take a look at dev.to example.

Declare your API with zodios


Here is an example of API declaration with Zodios.
  
  1. ```typescript
  2. import { Zodios } from "@zodios/core";
  3. import { z } from "zod";

  5. const apiClient = new Zodios(
  6.   "https://jsonplaceholder.typicode.com",
  7.   // API definition
  8.   [
  9.     {
  10.       method: "get",
  11.       path: "/users/:id", // auto detect :id and ask for it in apiClient get params
  12.       alias: "getUser", // optionnal alias to call this endpoint with it
  13.       description: "Get a user",
  14.       response: z.object({
  15.         id: z.number(),
  16.         name: z.string(),
  17.       }),
  18.     },
  19.   ],
  20. );
  21. ```

Calling this API is now easy and has builtin autocomplete features :  
  
  1. ```typescript
  2. //   typed                     auto-complete path   auto-complete params
  3. //     ▼                               ▼                   ▼
  4. const user = await apiClient.get("/users/:id", { params: { id: 7 } });
  5. console.log(user);
  6. ```
  
It should output  
  
  1. ```js
  2. { id: 7, name: 'Kurtis Weissnat' }
  3. ```
You can also use aliases :
  
  1. ```typescript
  2. //   typed                     alias   auto-complete params
  3. //     ▼                        ▼                ▼
  4. const user = await apiClient.getUser({ params: { id: 7 } });
  5. console.log(user);
  6. ```

API definition format


  1. ```typescript
  2. type ZodiosEndpointDescriptions = Array<{
  3.   method: 'get'|'post'|'put'|'patch'|'delete';
  4.   path: string; // example: /posts/:postId/comments/:commentId
  5.   alias?: string; // example: getPostComments
  6.   immutable?: boolean; // flag a post request as immutable to allow it to be cached with react-query
  7.   description?: string;
  8.   requestFormat?: 'json'|'form-data'|'form-url'|'binary'|'text'; // default to json if not set
  9.   parameters?: Array<{
  10.     name: string;
  11.     description?: string;
  12.     type: 'Path'|'Query'|'Body'|'Header';
  13.     schema: ZodSchema; // you can use zod `transform` to transform the value of the parameter before sending it to the server
  14.   }>;
  15.   response: ZodSchema; // you can use zod `transform` to transform the value of the response before returning it
  16.   status?: number; // default to 200, you can use this to override the sucess status code of the response (only usefull for openapi and express)
  17.   responseDescription?: string; // optional response description of the endpoint
  18.   errors?: Array<{
  19.     status: number | 'default';
  20.     description?: string;
  21.     schema: ZodSchema; // transformations are not supported on error schemas
  22.   }>;
  23. }>;
  24. ```

Full documentation


Check out the full documentation or following shortcuts.

- API definition
- Http client
- React hooks
- Solid hooks
- API server
- Nextjs integration

Ecosystem


- openapi-zod-client: generate a zodios client from an openapi specification
- @zodios/express: full end to end type safety like tRPC, but for REST APIs
- @zodios/plugins : some plugins for zodios
- @zodios/react : a react-query wrapper for zodios
- @zodios/solid : a solid-query wrapper for zodios

Roadmap for v11


for Zod / Io-Ts` :

  - By using the TypeProvider pattern we can now make zodios validation agnostic.

  - Implement at least ZodTypeProvider and IoTsTypeProvider since they both support input and output type inferrence

  - openapi generation will only be compatible with zod though

  - Not a breaking change so no codemod needed

- [x] MonoRepo:

  - Zodios will become a really large project so maybe migrate to turbo repo + pnpm

  - not a breaking change

- [ ] Transform:

  - By default, activate transforms on backend and disable on frontend (today it's the opposite), would make server transform code simpler since with this option we could make any transforms activated not just zod defaults.

  - Rationale being that transformation can be viewed as business code that should be kept on backend

  - breaking change => codemod to keep current defaults by setting them explicitly

- [x] Axios:

  - Move Axios client to it's own package @zodios/axios and keep @zodios/core with only common types and helpers

  - Move plugins to @zodios/axios-plugins

  - breaking change => easy to do a codemod for this

- [x] Fetch:

  - Create a new Fetch client with almost the same features as axios, but without axios dependency @zodios/fetch

  - Today we have fetch support with a plugin for axios instance (zodios maintains it's own axios network adapter for fetch). But since axios interceptors are not used by zodios plugins, we can make fetch implementation lighter than axios instance.

  - Create plugins package @zodios/fetch-plugins

  - Not sure it's doable without a lot of effort to keep it in sync/compatible with axios client

  - new feature, so no codemod needed

- [ ] React/Solid:  

   - make ZodiosHooks independant of Zodios client instance (axios, fetch)

   - not a breaking change, so no codemod needed

- [x] Client Request Config

  - uniform Query/Mutation with body sent on the config and not as a standalone object. This would allow to not do client.deleteUser(undefined, { params: { id: 1 } }) but simply  client.deleteUser({ params: { id: 1 } })

  - breaking change, so a codemod would be needed, but might be difficult to implement

- [x] Mock/Tests:

  - if we implement an abstraction layer for client instance, relying on moxios to mock APIs response will likely not work for fetch implementation.

  - create a @zodios/testing package that work for both axios/fetch clients

  - new feature, so no breaking change (no codemod needed)

You have other ideas ? Let me know !

Dependencies


Zodios even when working in pure Javascript is better suited to be working with Typescript Language Server to handle autocompletion.
So you should at least use the one provided by your IDE (vscode integrates a typescript language server)
However, we will only support fixing bugs related to typings for versions of Typescript Language v4.5
Earlier versions should work, but do not have TS tail recusion optimisation that impact the size of the API you can declare.

Also note that Zodios do not embed any dependency. It's your Job to install the peer dependencies you need.  
  
Internally Zodios uses these libraries on all platforms :
- zod
- axios