https://github.com/balisecode/swaggerclientgenerator

https://github.com/balisecode/swaggerclientgenerator

Last synced: 10 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/balisecode/swaggerclientgenerator
• Owner: BaliseCode
• Created: 2023-04-23T17:09:01.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-06-15T18:53:47.000Z (over 2 years ago)
• Last Synced: 2025-02-26T04:12:06.581Z (10 months ago)
• Language: JavaScript
• Size: 9.77 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Introduction

Swagger Client Generator is a tool that enables developers to easily parse Swagger API specification files and generate code bindings that are type safe using the popular validation library Zod and the flexible HTTP client Wretch. Swagger Client Generator makes it easy to generate high-quality code that is both scalable and maintainable. 

# Generate your API client

## Installation

    npm install @balise/swagger-client-generator

The following code explains how to generate code bindings from a swagger.json file.

    import SwaggerGenerateClient from "@balise/swagger-client-generator";

    let Query = new SwaggerGenerateClient('inputfile.json', 'outputfile.ts');

## Integrate with Vite 

Todo

# Use the API client

## Instanciate the API

To use the Api you can add the following code to your application to instanciate a caller. That will create a Call object that you can use to call your API.

    import ApiCallerInstance from "./outputfile";

    const Call = new ApiCallerInstance({

        rootUrl: 'https://localhost:3000',

        headers: {

            'Bearer: 'SomeToken'

        }

    }).ApiCall;

## Make an API Call

Next when you need to call the API you can use the following pattern

    let u = {

        first_name: "James", 

        last_name: "Bond"

    }

    Call.Projets.Users.post(u).then((res) => {

        console.log(res)

    }).catch((err) => {

        console.error(err)

    });

the *u* object will be validated trough the Zod library, and wrech will make a post request at the *https://localhost:3000/Projets/Users* endpoint using the bearer token from the setup

#Types

The Library also generates and exports Types and Validators from schemas from the Swagger file. 

For the Project schema, ProjectValidator is a Zod validator and ProjectType is a type infered from this validator