SdkGenerator 1.3.4

Swashbuckle SDK Generator

This program allows you to generate a hand-optimized software development kit for different programming languages for your REST API. It can also generate documentation in Markdown or Readme formats.

Example usage of this program:

• ProjectManager

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

2. Create a project file, then fill out all the values you want to use in it

> sdkgenerator create -p .\myapi.json

3. 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.

Automating SDK patches

If you publish updates to your API regularly, you can use GitHub Actions to automatically check for changes to your OpenAPI / Swagger file and generate a new software development kit.

Create a GitHub action using this template:

name: Check for OpenAPI updates

on:
  schedule:
    - cron: "0 0 * * 0" # Run once per week

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Setup .NET Core @ Latest
        uses: actions/setup-dotnet@v4
        with:
          dotnet-version: "8.0.x"

      - name: Add the SDK Generator
        run: dotnet tool install SdkGenerator --global

      - name: Generate the latest SDK
        run: SdkGenerator build -p ./sdk-config.json

      - name: Save patch notes
        id: patch-notes
        run: SdkGenerator get-patch-notes -p ./sdk-config.json

      - name: Save pull request name
        id: pr-name
        run: SdkGenerator get-release-name -p ./sdk-config.json

      - name: Create Pull Request
        id: cpr
        uses: peter-evans/create-pull-request@v6
        with:
          commit-message: ${{ steps.patch-notes.outputs }}
          title: ${{ steps.pr-name.outputs }}

Supported Languages

Supported Tools

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
• Each API has a unique summary value in the swagger file which will be used as method names for the SDK

Attribution

Puzzle icons created by Freepik - Flaticon