SdkGenerator 1.1.3

There is a newer version of this package available.
See the version list below for details. 
dotnet add package SdkGenerator --version 1.1.3                

                    
                

            
NuGet\Install-Package SdkGenerator -Version 1.1.3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="SdkGenerator" Version="1.1.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add SdkGenerator --version 1.1.3                

                    
                

            
#r "nuget: SdkGenerator, 1.1.3"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install SdkGenerator as a Cake Addin
#addin nuget:?package=SdkGenerator&version=1.1.3

// Install SdkGenerator as a Cake Tool
#tool nuget:?package=SdkGenerator&version=1.1.3

NuGet

Swashbuckle SDK Generator

This program allows you to generate a hand-optimized software development kit for different programming languages for your REST API.

This opinionated software makes assumptions about your API and attempts to create a SDK that matches good practices in each programming language. The OpenAPI / Swagger spec permits lots of different ways of doing things; this tool is intended to work only with commonly seen use cases.

Using this program

Here's how to use this program.

  1. Install the program using NuGet
> dotnet tool install --global SdkGenerator
  1. Create a project file, then fill out all the values you want to use in it
> sdkgenerator create -p .\myapi.json
  1. Run the program and build a single language OR build all languages
> sdkgenerator build -p .\myapi.json

You can automate these steps in a Github workflow to execute this program automatically on new releases.

Supported Languages

Language Supported Github Workflows Notes
C# Yes Automated Most complete support
Dart In Progress No In development
Java Yes No
Python Yes No
Ruby In Progress No Somewhat supported
TypeScript Yes No

Supported Tools

Language Supported Notes
Readme Yes Markdown-formatted documentation can upload to Guide pages
Workato Partially Somewhat supported

OpenAPI assumptions

Examples of assumptions about OpenAPI made by this program:

  • Only supports OpenAPI 3.0
  • Your server supports GZIP encoding and HTTPS connection pooling
  • An endpoint returns only a single data type and a single error type
  • Each API has a single-word category, a four-word title, and a long remarks section that is a description
  • You have a list of public environments (e.g. production, sandbox) that are documented in the SDK
  • For test environments or dedicated servers, an SDK user must define a custom environment URL
  • Enums are sometimes unsafe for SDK usage; all enums are converted to integers or strings
  • Nobody intentionally adds HttpStatusCode to their swagger file; if it appears, ignore it.

Attribution

Puzzle icons created by Freepik - Flaticon

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

  • net7.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.3.8 127 10/30/2024
1.3.7 138 10/20/2024
1.3.6 124 10/18/2024
1.3.5 111 10/5/2024
1.3.4 84 9/30/2024
1.3.3 108 9/13/2024
1.3.2 109 9/3/2024
1.3.1 137 8/18/2024
1.3.0 128 8/13/2024
1.2.9 117 8/13/2024
1.2.8 119 8/13/2024
1.2.7 127 8/13/2024 1.2.7 is deprecated because it has critical bugs.
1.2.6 113 7/25/2024 1.2.6 is deprecated because it has critical bugs.
1.2.5 197 3/14/2024
1.2.4 194 2/10/2024
1.2.3 213 1/29/2024
1.2.2 204 1/12/2024
1.2.1 322 10/22/2023
1.2.0 271 10/11/2023
1.1.9 249 10/9/2023
1.1.8 222 9/14/2023
1.1.7 229 9/10/2023
1.1.6 318 8/22/2023
1.1.5 266 8/22/2023
1.1.4 272 8/22/2023
1.1.3 278 8/22/2023
1.1.2 187 8/22/2023
1.1.2-beta 189 8/22/2023
1.1.1 174 8/19/2023
1.1.0 149 8/18/2023
1.0.0 197 7/28/2023

# 1.1.2
           August 21, 2023

           * Fixed tool deployment