\n\nhttps://user-images.githubusercontent.com/633115/185851987-554f5686-cb78-4096-8ff5-c8d61b645608.mp4\n\n# What is it ?\n\nIt's an axios compatible API client and an optional expressJS compatible API server with the following features: \n \n- really simple centralized API declaration\n- typescript autocompletion in your favorite IDE for URL and parameters\n- typescript response types\n- parameters and responses schema thanks to zod\n- response schema validation\n- powerfull plugins like `fetch` adapter or `auth` automatic injection\n- all axios features available\n- `@tanstack/query` wrappers for react and solid (vue, svelte, etc, soon)\n- all expressJS features available (middlewares, etc.)\n\n \n**Table of contents:**\n\n- [What is it ?](#what-is-it-)\n- [Install](#install)\n - [Client and api definitions :](#client-and-api-definitions-)\n - [Server :](#server-)\n- [How to use it on client side ?](#how-to-use-it-on-client-side-)\n - [Declare your API with zodios](#declare-your-api-with-zodios)\n - [API definition format](#api-definition-format)\n- [Full documentation](#full-documentation)\n- [Ecosystem](#ecosystem)\n- [Roadmap](#roadmap)\n- [Dependencies](#dependencies)\n\n# Install\n\n## Client and api definitions :\n\n```bash\n> npm install @zodios/core\n```\n\nor\n\n```bash\n> yarn add @zodios/core\n```\n\n## Server :\n \n```bash\n> npm install @zodios/core @zodios/express\n```\n\nor\n\n```bash\n> yarn add @zodios/core @zodios/express\n```\n\n# How to use it on client side ?\n\nFor an almost complete example on how to use zodios and how to split your APIs declarations, take a look at [dev.to](examples/dev.to/) example.\n\n## Declare your API with zodios\n\nHere is an example of API declaration with Zodios.\n \n```typescript\nimport { Zodios } from \"@zodios/core\";\nimport { z } from \"zod\";\n\nconst apiClient = new Zodios(\n \"https://jsonplaceholder.typicode.com\",\n // API definition\n [\n {\n method: \"get\",\n path: \"/users/:id\", // auto detect :id and ask for it in apiClient get params\n alias: \"getUser\", // optionnal alias to call this endpoint with it\n description: \"Get a user\",\n response: z.object({\n id: z.number(),\n name: z.string(),\n }),\n },\n ],\n);\n```\n\nCalling this API is now easy and has builtin autocomplete features : \n \n```typescript\n// typed auto-complete path auto-complete params\n// ▼ ▼ ▼\nconst user = await apiClient.get(\"/users/:id\", { params: { id: 7 } });\nconsole.log(user);\n```\n \nIt should output \n \n```js\n{ id: 7, name: 'Kurtis Weissnat' }\n```\nYou can also use aliases :\n \n```typescript\n// typed alias auto-complete params\n// ▼ ▼ ▼\nconst user = await apiClient.getUser({ params: { id: 7 } });\nconsole.log(user);\n```\n## API definition format\n\n```typescript\ntype ZodiosEndpointDescriptions = Array<{\n method: 'get'|'post'|'put'|'patch'|'delete';\n path: string; // example: /posts/:postId/comments/:commentId\n alias?: string; // example: getPostComments\n immutable?: boolean; // flag a post request as immutable to allow it to be cached with react-query\n description?: string;\n requestFormat?: 'json'|'form-data'|'form-url'|'binary'|'text'; // default to json if not set\n parameters?: Array<{\n name: string;\n description?: string;\n type: 'Path'|'Query'|'Body'|'Header';\n schema: ZodSchema; // you can use zod `transform` to transform the value of the parameter before sending it to the server\n }>;\n response: ZodSchema; // you can use zod `transform` to transform the value of the response before returning it\n status?: number; // default to 200, you can use this to override the sucess status code of the response (only usefull for openapi and express)\n responseDescription?: string; // optional response description of the endpoint\n errors?: Array<{\n status: number | 'default';\n description?: string;\n schema: ZodSchema; // transformations are not supported on error schemas\n }>;\n}>;\n```\n# Full documentation\n\nCheck out the [full documentation](https://www.zodios.org) or following shortcuts.\n\n- [API definition](https://www.zodios.org/docs/category/zodios-api-definition)\n- [Http client](https://www.zodios.org/docs/category/zodios-client)\n- [React hooks](https://www.zodios.org/docs/client/react)\n- [Solid hooks](https://www.zodios.org/docs/client/solid)\n- [API server](http://www.zodios.org/docs/category/zodios-server)\n- [Nextjs integration](http://www.zodios.org/docs/server/next)\n\n# Ecosystem\n\n- [openapi-zod-client](https://github.com/astahmer/openapi-zod-client): generate a zodios client from an openapi specification\n- [@zodios/express](https://github.com/ecyrbe/zodios-express): full end to end type safety like tRPC, but for REST APIs\n- [@zodios/plugins](https://github.com/ecyrbe/zodios-plugins) : some plugins for zodios\n- [@zodios/react](https://github.com/ecyrbe/zodios-react) : a react-query wrapper for zodios\n- [@zodios/solid](https://github.com/ecyrbe/zodios-solid) : a solid-query wrapper for zodios\n\n# Roadmap\n\nThe following will need investigation to check if it's doable :\n- implement `@zodios/nestjs` to define your API endpoints with nestjs and share it with your frontend (like tRPC)\n- generate openAPI json from your API endpoints\n\nYou have other ideas ? [Let me know !](https://github.com/ecyrbe/zodios/discussions)\n# Dependencies\n\nZodios even when working in pure Javascript is better suited to be working with Typescript Language Server to handle autocompletion.\nSo you should at least use the one provided by your IDE (vscode integrates a typescript language server)\nHowever, we will only support fixing bugs related to typings for versions of Typescript Language v4.5\nEarlier versions should work, but do not have TS tail recusion optimisation that impact the size of the API you can declare.\n\nAlso note that Zodios do not embed any dependency. It's your Job to install the peer dependencies you need. \n \nInternally Zodios uses these libraries on all platforms :\n- zod\n- axios\n","readmeFilename":"README.md"}
![\"Zodios](\"https://raw.githubusercontent.com/ecyrbe/zodios/main/docs/logo.svg\"){kind=logo}
\n \n ![\"langue](\"https://img.shields.io/npm/v/@zodios/core.svg\")
\n ![\"npm\"](\"https://img.shields.io/npm/dw/@zodios/core\")
\n ![\"GitHub\"](\"https://img.shields.io/github/license/ecyrbe/zodios\")
\n ![\"GitHub](\"https://img.shields.io/github/workflow/status/ecyrbe/zodios/CI\")
\n