Skip to main content

Introduction

Zodios is a REST API toolbox with end-to-end typesafety.
It allows you to create a REST API with a clean, intuitive and declarative syntax.

It's best used with TypeScript, but it's also usable with pure JavaScript.

It's composed of multiple packages :

PackageTypeDescription
@zodios/coreFrontend BackendThe core library that contains an API client with full typesafety and autocompletion.
You can use it as a standalone API client without using other modules.
@zodios/pluginsFrontend BackendA set of plugins for the API client.
@zodios/reactFrontendReact hooks for the client based on tanstack-query.
@zodios/solidFrontendSolid hooks for the client based on tanstack-query.
@zodios/expressBackendA simple adapter for Express but with full typesafety and autocompletion.
@zodios/openapiBackendHelper that generates OpenAPI specs from Zodios API definitions and allows you to easily generate swagger ui.
It's worth noting that frontend and backend packages can be used as standalone packages.

Meaning that you don't need to use Zodios Backend to use Zodios Frontend packages and vice-versa. Allowing you to scale the development of your API between frontend and backend teams.

You only need to share the API definition between the two teams.