zodios

Zodios

│

Zodios is a typescript api client with auto-completion features backed by zod and typescript

What is it ?

It's an API client, made with axios, zod and typescript to allow easy client API definitions

Install

> npm install zodios

or

> yarn add zodios

Declare your API with zodios

import { Zodios } from "zodios";
import { z } from "zod";

const apiClient = new Zodios(
  "https://jsonplaceholder.typicode.com",
  {
    getToken: () => Promise.resolve("token"),
  },
  [
    {
      method: "get",
      path: "/users/:id",
      description: "Get a user",
      parameters: [
        {
          type: "Path",
          name: "id",
          schema: z.number(),
        },
      ],
      response: z.object({
        id: z.number(),
        name: z.string(),
      }),
    },
  ] as const
);
//                               auto-complete url  auto-complete params
//                                    ▼                   ▼
const user = await apiClient.get("/users/:id", { params: { id: 7 } });
console.log(user);
// Output: { id: 7, name: 'Kurtis Weissnat' }