Skip to main content

​
Overview

The Integration class generates TypeScript client code with full type safety from your API routes. 
import { Integration } from "express-zod-api";
import typescript from "typescript";

const client = new Integration({
  typescript,
  routing,
  config,
  variant: "client",
});

const code = await client.printFormatted();
fs.writeFileSync("client.ts", code);

​
Configuration

​
typescript
typeof import('typescript')
required
TypeScript compiler API
​
routing
Routing
required
Your API routing object
​
config
Config
required
Your Express Zod API configuration
​
variant
'client' | 'types'
Generation mode:
  • "client": Full client with fetch implementation
  • "types": Types only for DIY clients
Default: "client"

​
Methods

​
print()

Generates unformatted TypeScript code. 
const code = client.print();

​
printFormatted()

Generates formatted TypeScript code using Prettier. 
const code = await client.printFormatted();

​
Integration.create()

Async factory method that imports TypeScript automatically. 
const client = await Integration.create({
  routing,
  config,
  variant: "client",
});

​
Generated Client

The generated client provides: 
// In your frontend/client code
import { Client } from "./generated-client";

const client = new Client({
  baseUrl: "https://api.example.com",
});

// Type-safe requests
const user = await client.provide("get /users/:id", {
  id: "123",
});

// All inputs and outputs are fully typed
const newPost = await client.provide("post /posts", {
  title: "Hello World",
  content: "...",
});

​
Custom Implementation

Override the default fetch implementation: 
import { Client, Implementation } from "./generated-client";
import axios from "axios";

const axiosImplementation: Implementation = async ({
  method,
  url,
  body,
  headers,
}) => {
  const response = await axios({ method, url, data: body, headers });
  return response.data;
};

const client = new Client(axiosImplementation);

​
Examples

​
Generate Client

import { Integration } from "express-zod-api";
import typescript from "typescript";
import { writeFileSync } from "fs";

const client = new Integration({
  typescript,
  routing,
  config,
  variant: "client",
});

const code = await client.printFormatted();
writeFileSync("src/api-client.ts", code);

​
Generate Types Only

const types = new Integration({
  typescript,
  routing,
  config,
  variant: "types",
});

const code = await types.printFormatted();
writeFileSync("src/api-types.ts", code);

​
Using the Generated Client

import { Client } from "./api-client";

const client = new Client({
  baseUrl: process.env.API_URL,
});

// GET request
const users = await client.provide("get /users", {
  limit: 10,
  offset: 0,
});

// POST request
const created = await client.provide("post /users", {
  name: "John Doe",
  email: "john@example.com",
});

// Path parameters
const user = await client.provide("get /users/:id", {
  id: "123",
});

// Server-Sent Events
import { Subscription } from "./api-client";

const subscription = new Subscription("get /events", {});

subscription.on("message", (data) => {
  console.log("Received:", data);
});

subscription.on("error", (error) => {
  console.error("Error:", error);
});

​
Pagination Support

const response = await client.provide("get /users", {
  limit: 20,
  offset: 0,
});

// Check if more pages available
if (client.hasMore(response)) {
  console.log("More users available");
}

​
See Also

End-to-End Type Safety

Complete client generation guide

Documentation

Generate OpenAPI specs