OpenApiGenerator.Cli 0.3.2

Suggested Alternatives

AutoSDK.CLI

There is a newer version of this package available.
See the version list below for details.
dotnet tool install --global OpenApiGenerator.Cli --version 0.3.2                
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local OpenApiGenerator.Cli --version 0.3.2                
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=OpenApiGenerator.Cli&version=0.3.2                
nuke :add-package OpenApiGenerator.Cli --version 0.3.2                

OpenApiGenerator

Allows you to partially (for example, only models) or completely generate a native (without dependencies) C# client sdk according to the OpenAPI specification.
Inspired by NSwag

🔥Features🔥

  • Uses Incremental Source Generators for efficient generation and caching.
  • Detects your TargetFramework and generates optimal code for it (including net6.0/net7.0/net8.0 improvements)
  • Supports .Net Framework/.Net Standard
  • Does not contain dependencies for modern versions of dotnet
  • Only System.Text.Json dependency for .Net Framework/.Net Standard
  • Any generated methods provide the ability to pass a CancellationToken
  • Allows partial generation (models only) or end points filtering
  • Available under MIT license for general users and most organizations
  • Uses https://github.com/microsoft/OpenAPI.NET for parsing OpenAPI specification
  • Supports trimming/native AOT compilation

🚀Quick start🚀

  • Install the package
dotnet add package OpenApiGenerator
  • Add the following to your csproj file. You can check all settings here:


<ItemGroup Label="OpenApiGenerator">
    <AdditionalFiles Include="$(MSBuildThisFileDirectory)../../../docs/openapi.yaml" />
</ItemGroup>

<PropertyGroup Label="OpenApiGenerator">
    <OpenApiGenerator_Namespace>Ollama</OpenApiGenerator_Namespace>
    <OpenApiGenerator_ClassName>OllamaApi</OpenApiGenerator_ClassName>
    <OpenApiGenerator_GenerateModels>true</OpenApiGenerator_GenerateModels>
    <OpenApiGenerator_GenerateSdk>false</OpenApiGenerator_GenerateSdk>
</PropertyGroup>
  • It's all! Now you can build your project and use the generated code. You also can use IDE to see the generated code in any moment, this is a example for Rider:
    rider_show_generated_code.png

CLI

You can use the CLI to generate the code.

dotnet tool install --global openapigenerator.cli --prerelease
oag --help
oag generate openapi.yaml

It will generate the code in the "openapi" subdirectory.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
0.22.6-dev.7 1,501 9/9/2024 0.22.6-dev.7 is deprecated because it is no longer maintained.
0.22.6-dev.6 46 9/9/2024 0.22.6-dev.6 is deprecated because it is no longer maintained.
0.22.6-dev.4 215 9/7/2024 0.22.6-dev.4 is deprecated because it is no longer maintained.
0.22.6-dev.2 75 9/7/2024 0.22.6-dev.2 is deprecated because it is no longer maintained.
0.22.6-dev.1 44 9/7/2024 0.22.6-dev.1 is deprecated because it is no longer maintained.
0.22.5 133 9/7/2024 0.22.5 is deprecated because it is no longer maintained.
0.22.4 93 9/7/2024 0.22.4 is deprecated because it is no longer maintained.
0.22.3 92 9/7/2024 0.22.3 is deprecated because it is no longer maintained.
0.22.2 104 9/7/2024 0.22.2 is deprecated because it is no longer maintained.
0.22.1 89 9/7/2024 0.22.1 is deprecated because it is no longer maintained.
0.22.0 90 9/7/2024 0.22.0 is deprecated because it is no longer maintained.
0.21.1 152 9/6/2024 0.21.1 is deprecated because it is no longer maintained.
0.21.0 94 9/6/2024 0.21.0 is deprecated because it is no longer maintained.
0.20.2 724 8/31/2024 0.20.2 is deprecated because it is no longer maintained.
0.20.1 98 8/31/2024 0.20.1 is deprecated because it is no longer maintained.
0.20.0 112 8/30/2024 0.20.0 is deprecated because it is no longer maintained.
0.19.0 119 8/30/2024 0.19.0 is deprecated because it is no longer maintained.
0.18.0 202 8/29/2024 0.18.0 is deprecated because it is no longer maintained.
0.17.1 126 8/28/2024 0.17.1 is deprecated because it is no longer maintained.
0.17.0 105 8/28/2024 0.17.0 is deprecated because it is no longer maintained.
0.16.4-dev.7 55 8/28/2024 0.16.4-dev.7 is deprecated because it is no longer maintained.
0.16.3 459 8/24/2024 0.16.3 is deprecated because it is no longer maintained.
0.16.2 124 8/24/2024 0.16.2 is deprecated because it is no longer maintained.
0.16.1 199 8/23/2024 0.16.1 is deprecated because it is no longer maintained.
0.16.0 169 8/22/2024 0.16.0 is deprecated because it is no longer maintained.
0.15.8 127 8/22/2024 0.15.8 is deprecated because it is no longer maintained.
0.15.7 251 8/19/2024 0.15.7 is deprecated because it is no longer maintained.
0.15.6 165 8/18/2024 0.15.6 is deprecated because it is no longer maintained.
0.15.5 115 8/18/2024 0.15.5 is deprecated because it is no longer maintained.
0.15.4 235 8/15/2024 0.15.4 is deprecated because it is no longer maintained.
0.15.3 175 8/13/2024 0.15.3 is deprecated because it is no longer maintained.
0.15.2 147 8/13/2024 0.15.2 is deprecated because it is no longer maintained.
0.15.1 134 8/12/2024 0.15.1 is deprecated because it is no longer maintained.
0.15.0 143 8/11/2024 0.15.0 is deprecated because it is no longer maintained.
0.14.3 270 8/6/2024 0.14.3 is deprecated because it is no longer maintained.
0.14.2 79 8/5/2024 0.14.2 is deprecated because it is no longer maintained.
0.14.1 68 8/5/2024 0.14.1 is deprecated because it is no longer maintained.
0.14.0 62 8/5/2024 0.14.0 is deprecated because it is no longer maintained.
0.13.11 379 7/22/2024 0.13.11 is deprecated because it is no longer maintained.
0.13.10 125 7/21/2024 0.13.10 is deprecated because it is no longer maintained.
0.13.9 126 7/18/2024 0.13.9 is deprecated because it is no longer maintained.
0.13.8 111 7/15/2024 0.13.8 is deprecated because it is no longer maintained.
0.13.7 95 7/15/2024 0.13.7 is deprecated because it is no longer maintained.
0.13.6 104 7/14/2024 0.13.6 is deprecated because it is no longer maintained.
0.13.5 101 7/14/2024 0.13.5 is deprecated because it is no longer maintained.
0.13.4 102 7/13/2024 0.13.4 is deprecated because it is no longer maintained.
0.13.3 117 7/9/2024 0.13.3 is deprecated because it is no longer maintained.
0.13.2 83 7/8/2024 0.13.2 is deprecated because it is no longer maintained.
0.13.1 96 7/8/2024 0.13.1 is deprecated because it is no longer maintained.
0.13.0 103 7/8/2024 0.13.0 is deprecated because it is no longer maintained.
0.12.2 106 7/8/2024 0.12.2 is deprecated because it is no longer maintained.
0.12.1 122 7/6/2024 0.12.1 is deprecated because it is no longer maintained.
0.12.0 114 7/6/2024 0.12.0 is deprecated because it is no longer maintained.
0.11.11 102 7/6/2024 0.11.11 is deprecated because it is no longer maintained.
0.11.10 102 7/6/2024 0.11.10 is deprecated because it is no longer maintained.
0.11.9 136 6/30/2024 0.11.9 is deprecated because it is no longer maintained.
0.11.8 123 6/30/2024 0.11.8 is deprecated because it is no longer maintained.
0.11.7 113 6/30/2024 0.11.7 is deprecated because it is no longer maintained.
0.11.6 115 6/29/2024 0.11.6 is deprecated because it is no longer maintained.
0.11.4 107 6/27/2024 0.11.4 is deprecated because it is no longer maintained.
0.11.3 129 6/27/2024 0.11.3 is deprecated because it is no longer maintained.
0.11.1 107 6/20/2024 0.11.1 is deprecated because it is no longer maintained.
0.11.0 114 6/16/2024 0.11.0 is deprecated because it is no longer maintained.
0.10.8 113 6/15/2024 0.10.8 is deprecated because it is no longer maintained.
0.10.7 113 6/15/2024 0.10.7 is deprecated because it is no longer maintained.
0.10.6 107 6/15/2024 0.10.6 is deprecated because it is no longer maintained.
0.10.4 108 6/13/2024 0.10.4 is deprecated because it is no longer maintained.
0.10.2 105 6/13/2024 0.10.2 is deprecated because it is no longer maintained.
0.10.1 100 6/13/2024 0.10.1 is deprecated because it is no longer maintained.
0.10.0 103 6/13/2024 0.10.0 is deprecated because it is no longer maintained.
0.9.12 106 6/6/2024 0.9.12 is deprecated because it is no longer maintained.
0.9.11 104 6/6/2024 0.9.11 is deprecated because it is no longer maintained.
0.9.10 106 6/5/2024 0.9.10 is deprecated because it is no longer maintained.
0.9.9 106 6/5/2024 0.9.9 is deprecated because it is no longer maintained.
0.9.8 119 6/4/2024 0.9.8 is deprecated because it is no longer maintained.
0.9.7 132 6/1/2024 0.9.7 is deprecated because it is no longer maintained.
0.9.5 112 5/31/2024 0.9.5 is deprecated because it is no longer maintained.
0.9.4 107 5/31/2024 0.9.4 is deprecated because it is no longer maintained.
0.9.3 116 5/31/2024 0.9.3 is deprecated because it is no longer maintained.
0.9.1 114 5/30/2024 0.9.1 is deprecated because it is no longer maintained.
0.9.0 108 5/30/2024 0.9.0 is deprecated because it is no longer maintained.
0.8.8 115 5/28/2024 0.8.8 is deprecated because it is no longer maintained.
0.8.6 106 5/27/2024 0.8.6 is deprecated because it is no longer maintained.
0.8.5 107 5/27/2024 0.8.5 is deprecated because it is no longer maintained.
0.8.4 125 5/27/2024 0.8.4 is deprecated because it is no longer maintained.
0.8.3 124 5/27/2024 0.8.3 is deprecated because it is no longer maintained.
0.8.1 126 5/25/2024 0.8.1 is deprecated because it is no longer maintained.
0.8.0 117 5/25/2024 0.8.0 is deprecated because it is no longer maintained.
0.7.2 116 5/23/2024 0.7.2 is deprecated because it is no longer maintained.
0.7.1 112 5/22/2024 0.7.1 is deprecated because it is no longer maintained.
0.7.0 130 5/22/2024 0.7.0 is deprecated because it is no longer maintained.
0.6.9 112 5/22/2024 0.6.9 is deprecated because it is no longer maintained.
0.6.8 115 5/21/2024 0.6.8 is deprecated because it is no longer maintained.
0.6.7 100 5/21/2024 0.6.7 is deprecated because it is no longer maintained.
0.6.6 111 5/19/2024 0.6.6 is deprecated because it is no longer maintained.
0.6.5 107 5/19/2024 0.6.5 is deprecated because it is no longer maintained.
0.6.4 121 5/19/2024 0.6.4 is deprecated because it is no longer maintained.
0.6.3 104 5/19/2024 0.6.3 is deprecated because it is no longer maintained.
0.6.2 107 5/19/2024 0.6.2 is deprecated because it is no longer maintained.
0.6.1 104 5/19/2024 0.6.1 is deprecated because it is no longer maintained.
0.6.0 105 5/19/2024 0.6.0 is deprecated because it is no longer maintained.
0.5.0 115 5/19/2024 0.5.0 is deprecated because it is no longer maintained.
0.4.0 115 5/19/2024 0.4.0 is deprecated because it is no longer maintained.
0.3.2 101 5/13/2024 0.3.2 is deprecated because it is no longer maintained.
0.3.1 97 5/13/2024 0.3.1 is deprecated because it is no longer maintained.
0.3.0 91 5/13/2024 0.3.0 is deprecated because it is no longer maintained.
0.2.0 98 5/11/2024 0.2.0 is deprecated because it is no longer maintained.

⭐ Last 10 features:
- feat: Updated OpenAI OpenAPI spec. 2024-05-13
- feat: Added parse diagnostic exceptions. 2024-05-13
- feat: Added support to compute operationId. 2024-05-13
- feat: Added initial support of OpenAI OpenAPI spec. 2024-05-13
- feat: Added Method overloads with parameters. 2024-05-13
- feat: Added EquatableArray to Core library. 2024-05-13
- feat: Added Streaming support. 2024-05-13
- feat: Added support for other HttpMethod types. 2024-05-13
- feat: Added support for generation of Get methods. 2024-05-13
- feat: Added GenerateConstructors/GenerateMethods settings. 2024-05-13
🐞 Last 10 bug fixes:
- fix: Try to fix tabs. 2024-05-13
- fix: Fixed Environment.NewLine. 2024-05-13
- fix: Initial support for OpenAI methods generation. 2024-05-13
- fix: Fixed [] in property name. 2024-05-13
- fix: Fixed issue with default value for array. 2024-05-13
- fix: Fixed enums with []. 2024-05-13
- fix: Fixed some other bugs with default values. 2024-05-13
- fix: Fixed empty default values. 2024-05-13
- fix: Fixed Enums that starts from digit. 2024-05-13
- fix: Fixed issue with Enum default values. 2024-05-13