Nest Sdk Generator

Overview

The nest-sdk-generator is an innovative tool designed for developers using NestJS servers. It streamlines the process of building a client-side SDK, enabling quick and efficient consumption of a NestJS server's API. By automating the generation of SDKs, this tool helps in maintaining type safety, enhancing IDE support, and ensuring that your client applications can easily interact with your APIs without the usual hassle.

With its dual-component architecture, the analyzer first scans your NestJS application to gather crucial information, building a comprehensive JSON schema. The generator then takes this schema to create a neatly organized SDK that mirrors the structure of your API, making it straightforward to navigate and utilize. Overall, nest-sdk-generator brings a new level of convenience and structure to API development.

Features

• Automatic SDK Generation: Quickly generates a full client-side SDK from your NestJS API using a simple command.

• Type Safety: Enforces type checking for API parameters and return values, catching issues at compile time rather than runtime.

• IDE Autocompletion: Improves developer experience with autocompletion for API parameters and return types directly in your code editor.

• Hierarchical Structure: Represents API routes in a structured hierarchy, mimicking the organization of controllers and modules in your backend.

• Customizable Requests: Includes a global request and response handler that allows customization of requests, such as adding headers or other values on-the-fly.

• Verbose Output: Provides detailed, colorful output that helps in debugging issues during the SDK generation process with options to log outputs for future reference.

• Clean Placeholders: Offers simple placeholders for server-side types that cannot be transferred to the client-side, maintaining clean code.

• Quick Setup: Requires minimal configuration to get started, needing only a JSON file to specify API location and an easy command to run.