SDKing

SDKing: A Powerful TypeScript SDK Generator

SDKing is a robust command-line tool designed for developers seeking to generate fully-typed TypeScript SDKs directly from OpenAPI specifications. This tool prioritizes type safety, ensuring that generated SDKs are precise and reliable, while also enhancing productivity through minimal configuration requirements.

Key Features

• Type-Safe SDKs: Generates comprehensive TypeScript SDKs that maintain complete type safety, reducing runtime errors.
• Zod-Powered Validation: Effortlessly validate API inputs and outputs with Zod, ensuring data integrity.
• Comprehensive OpenAPI Support: Fully compatible with all HTTP methods, parameters, and schemas, allowing for flexibility in API integration.
• Flexible Spec Loading: Easily load specifications from local files or remote URLs, enhancing accessibility.
• Minimal Setup: Get started quickly without the need for boilerplate code, increasing productivity right from the start.

Usage Overview

To generate an SDK from an OpenAPI spec, the following command can be executed:

npx sdking -i path/to/spec.yaml -o ./sdk

For verbose logging or using a spec from a URL, the command can be adjusted accordingly:

npx sdking -i https://petstore3.swagger.io/api/v3/openapi.yaml -o ./petstore-sdk

Example SDK Usage

Once the SDK is generated, API endpoints can be accessed in a type-safe manner:

// Fetch all pets
await client.pets.get();
// Create a new pet
await client.pets.post({ name: "Buddy" });
// Get a pet by ID
await client.pets.$petId.get({ petId: 1 });
// Delete a pet by ID
await client.pets.$petId.del({ petId: 1 }); // Using .del() due to reserved word
// Pass custom headers
await client.pets.get({ petId: 1 }, { Authorization: "Bearer token" });

Integration with React Query is seamless, allowing for efficient data fetching:

import { useQuery } from "@tanstack/react-query";
import { client } from "./sdk";

const PetsList = () => {
  const { data: pets, isLoading } = useQuery({
    queryKey: ["pets"],
    queryFn: () => client.pets.get(),
  });

  if (isLoading) return <p>Loading...</p>;

  return (
    <ul>
      {pets?.map((pet) => (
        <li key={pet.id}>{pet.name}</li>
      ))}
    </ul>
  );
};

Customization and Ownership

All generated code is owned by the user, providing complete freedom to customize according to specific project requirements. The configuration settings, including the API server URL and default headers, can be easily modified in the config.ts file.

Modular SDK Structure

The generated SDK maintains a clean and intuitive folder structure, which simplifies navigation:

sdk/
├── config.ts               # SDK configuration
├── index.ts                # Main exports
├── package.json            # Package metadata
├── README.md               # Usage documentation
├── schemas/                # Zod validation schemas
│   ├── index.ts            # Re-exports all schemas
│   └── ...                 # Individual schema files
└── routes/                 # API route handlers
    ├── index.ts            # Re-exports all routes
    └── ...                 # Individual route files

SDKing is developed with the intent to streamline API integration, offering a developer-friendly experience while ensuring the reliability of the generated SDKs. It is suitable for use in various projects, especially those leveraging TypeScript and OpenAPI specifications.