OpenApiGenerator.Cli 0.3.0

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.0
                    
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.0
                    
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=OpenApiGenerator.Cli&version=0.3.0
                    
nuke :add-package OpenApiGenerator.Cli --version 0.3.0
                    

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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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,586 9/9/2024 0.22.6-dev.7 is deprecated because it is no longer maintained.
0.22.6-dev.6 80 9/9/2024 0.22.6-dev.6 is deprecated because it is no longer maintained.
0.22.6-dev.4 252 9/7/2024 0.22.6-dev.4 is deprecated because it is no longer maintained.
0.22.6-dev.2 110 9/7/2024 0.22.6-dev.2 is deprecated because it is no longer maintained.
0.22.6-dev.1 79 9/7/2024 0.22.6-dev.1 is deprecated because it is no longer maintained.
0.22.5 225 9/7/2024 0.22.5 is deprecated because it is no longer maintained.
0.22.4 138 9/7/2024 0.22.4 is deprecated because it is no longer maintained.
0.22.3 139 9/7/2024 0.22.3 is deprecated because it is no longer maintained.
0.22.2 152 9/7/2024 0.22.2 is deprecated because it is no longer maintained.
0.22.1 146 9/7/2024 0.22.1 is deprecated because it is no longer maintained.
0.22.0 138 9/7/2024 0.22.0 is deprecated because it is no longer maintained.
0.21.1 204 9/6/2024 0.21.1 is deprecated because it is no longer maintained.
0.21.0 151 9/6/2024 0.21.0 is deprecated because it is no longer maintained.
0.20.2 768 8/31/2024 0.20.2 is deprecated because it is no longer maintained.
0.20.1 141 8/31/2024 0.20.1 is deprecated because it is no longer maintained.
0.20.0 156 8/30/2024 0.20.0 is deprecated because it is no longer maintained.
0.19.0 162 8/30/2024 0.19.0 is deprecated because it is no longer maintained.
0.18.0 244 8/29/2024 0.18.0 is deprecated because it is no longer maintained.
0.17.1 173 8/28/2024 0.17.1 is deprecated because it is no longer maintained.
0.17.0 145 8/28/2024 0.17.0 is deprecated because it is no longer maintained.
0.16.4-dev.7 93 8/28/2024 0.16.4-dev.7 is deprecated because it is no longer maintained.
0.16.3 504 8/24/2024 0.16.3 is deprecated because it is no longer maintained.
0.16.2 174 8/24/2024 0.16.2 is deprecated because it is no longer maintained.
0.16.1 247 8/23/2024 0.16.1 is deprecated because it is no longer maintained.
0.16.0 218 8/22/2024 0.16.0 is deprecated because it is no longer maintained.
0.15.8 179 8/22/2024 0.15.8 is deprecated because it is no longer maintained.
0.15.7 298 8/19/2024 0.15.7 is deprecated because it is no longer maintained.
0.15.6 214 8/18/2024 0.15.6 is deprecated because it is no longer maintained.
0.15.5 159 8/18/2024 0.15.5 is deprecated because it is no longer maintained.
0.15.4 289 8/15/2024 0.15.4 is deprecated because it is no longer maintained.
0.15.3 225 8/13/2024 0.15.3 is deprecated because it is no longer maintained.
0.15.2 202 8/13/2024 0.15.2 is deprecated because it is no longer maintained.
0.15.1 180 8/12/2024 0.15.1 is deprecated because it is no longer maintained.
0.15.0 190 8/11/2024 0.15.0 is deprecated because it is no longer maintained.
0.14.3 317 8/6/2024 0.14.3 is deprecated because it is no longer maintained.
0.14.2 125 8/5/2024 0.14.2 is deprecated because it is no longer maintained.
0.14.1 111 8/5/2024 0.14.1 is deprecated because it is no longer maintained.
0.14.0 112 8/5/2024 0.14.0 is deprecated because it is no longer maintained.
0.13.11 427 7/22/2024 0.13.11 is deprecated because it is no longer maintained.
0.13.10 170 7/21/2024 0.13.10 is deprecated because it is no longer maintained.
0.13.9 172 7/18/2024 0.13.9 is deprecated because it is no longer maintained.
0.13.8 158 7/15/2024 0.13.8 is deprecated because it is no longer maintained.
0.13.7 143 7/15/2024 0.13.7 is deprecated because it is no longer maintained.
0.13.6 144 7/14/2024 0.13.6 is deprecated because it is no longer maintained.
0.13.5 143 7/14/2024 0.13.5 is deprecated because it is no longer maintained.
0.13.4 149 7/13/2024 0.13.4 is deprecated because it is no longer maintained.
0.13.3 164 7/9/2024 0.13.3 is deprecated because it is no longer maintained.
0.13.2 123 7/8/2024 0.13.2 is deprecated because it is no longer maintained.
0.13.1 142 7/8/2024 0.13.1 is deprecated because it is no longer maintained.
0.13.0 152 7/8/2024 0.13.0 is deprecated because it is no longer maintained.
0.12.2 154 7/8/2024 0.12.2 is deprecated because it is no longer maintained.
0.12.1 166 7/6/2024 0.12.1 is deprecated because it is no longer maintained.
0.12.0 157 7/6/2024 0.12.0 is deprecated because it is no longer maintained.
0.11.11 159 7/6/2024 0.11.11 is deprecated because it is no longer maintained.
0.11.10 144 7/6/2024 0.11.10 is deprecated because it is no longer maintained.
0.11.9 170 6/30/2024 0.11.9 is deprecated because it is no longer maintained.
0.11.8 165 6/30/2024 0.11.8 is deprecated because it is no longer maintained.
0.11.7 160 6/30/2024 0.11.7 is deprecated because it is no longer maintained.
0.11.6 154 6/29/2024 0.11.6 is deprecated because it is no longer maintained.
0.11.4 149 6/27/2024 0.11.4 is deprecated because it is no longer maintained.
0.11.3 180 6/27/2024 0.11.3 is deprecated because it is no longer maintained.
0.11.1 148 6/20/2024 0.11.1 is deprecated because it is no longer maintained.
0.11.0 162 6/16/2024 0.11.0 is deprecated because it is no longer maintained.
0.10.8 165 6/15/2024 0.10.8 is deprecated because it is no longer maintained.
0.10.7 152 6/15/2024 0.10.7 is deprecated because it is no longer maintained.
0.10.6 150 6/15/2024 0.10.6 is deprecated because it is no longer maintained.
0.10.4 150 6/13/2024 0.10.4 is deprecated because it is no longer maintained.
0.10.2 145 6/13/2024 0.10.2 is deprecated because it is no longer maintained.
0.10.1 145 6/13/2024 0.10.1 is deprecated because it is no longer maintained.
0.10.0 147 6/13/2024 0.10.0 is deprecated because it is no longer maintained.
0.9.12 145 6/6/2024 0.9.12 is deprecated because it is no longer maintained.
0.9.11 144 6/6/2024 0.9.11 is deprecated because it is no longer maintained.
0.9.10 151 6/5/2024 0.9.10 is deprecated because it is no longer maintained.
0.9.9 144 6/5/2024 0.9.9 is deprecated because it is no longer maintained.
0.9.8 159 6/4/2024 0.9.8 is deprecated because it is no longer maintained.
0.9.7 173 6/1/2024 0.9.7 is deprecated because it is no longer maintained.
0.9.5 157 5/31/2024 0.9.5 is deprecated because it is no longer maintained.
0.9.4 154 5/31/2024 0.9.4 is deprecated because it is no longer maintained.
0.9.3 163 5/31/2024 0.9.3 is deprecated because it is no longer maintained.
0.9.1 160 5/30/2024 0.9.1 is deprecated because it is no longer maintained.
0.9.0 149 5/30/2024 0.9.0 is deprecated because it is no longer maintained.
0.8.8 164 5/28/2024 0.8.8 is deprecated because it is no longer maintained.
0.8.6 154 5/27/2024 0.8.6 is deprecated because it is no longer maintained.
0.8.5 149 5/27/2024 0.8.5 is deprecated because it is no longer maintained.
0.8.4 162 5/27/2024 0.8.4 is deprecated because it is no longer maintained.
0.8.3 170 5/27/2024 0.8.3 is deprecated because it is no longer maintained.
0.8.1 172 5/25/2024 0.8.1 is deprecated because it is no longer maintained.
0.8.0 161 5/25/2024 0.8.0 is deprecated because it is no longer maintained.
0.7.2 167 5/23/2024 0.7.2 is deprecated because it is no longer maintained.
0.7.1 171 5/22/2024 0.7.1 is deprecated because it is no longer maintained.
0.7.0 174 5/22/2024 0.7.0 is deprecated because it is no longer maintained.
0.6.9 152 5/22/2024 0.6.9 is deprecated because it is no longer maintained.
0.6.8 156 5/21/2024 0.6.8 is deprecated because it is no longer maintained.
0.6.7 148 5/21/2024 0.6.7 is deprecated because it is no longer maintained.
0.6.6 158 5/19/2024 0.6.6 is deprecated because it is no longer maintained.
0.6.5 153 5/19/2024 0.6.5 is deprecated because it is no longer maintained.
0.6.4 162 5/19/2024 0.6.4 is deprecated because it is no longer maintained.
0.6.3 144 5/19/2024 0.6.3 is deprecated because it is no longer maintained.
0.6.2 146 5/19/2024 0.6.2 is deprecated because it is no longer maintained.
0.6.1 142 5/19/2024 0.6.1 is deprecated because it is no longer maintained.
0.6.0 146 5/19/2024 0.6.0 is deprecated because it is no longer maintained.
0.5.0 157 5/19/2024 0.5.0 is deprecated because it is no longer maintained.
0.4.0 158 5/19/2024 0.4.0 is deprecated because it is no longer maintained.
0.3.2 140 5/13/2024 0.3.2 is deprecated because it is no longer maintained.
0.3.1 134 5/13/2024 0.3.1 is deprecated because it is no longer maintained.
0.3.0 135 5/13/2024 0.3.0 is deprecated because it is no longer maintained.
0.2.0 136 5/11/2024 0.2.0 is deprecated because it is no longer maintained.

⭐ Last 10 features:
- 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
- feat: Added Settings.UseRequiredKeyword. 2024-05-11
- feat: Added ability to use Newtonsoft.Json. 2024-05-11
- feat: Added CLI tool. 2024-05-11
- feat: Make Core lib multi-target. 2024-05-11
- feat: Added support for OpenAI.CreateModerationResponse. 2024-01-08
- feat: Added initial endpoints generation. 2024-01-08
🐞 Last 10 bug fixes:
- fix: Fixed missing EquatableArray. 2024-05-13
- fix: Moved CLI. 2024-05-11
- fix: Fixed issue <> in xml docs. 2024-05-10
- fix: Added missing xml doc for AdditionalProperties. 2024-05-10
- fix: Released. 2024-05-10
- fix: Fixed issue with enum names with whitespace separator. 2024-05-10
- fix: Try to do models public. 2024-01-08
- fix: Try to use IsExternalInit. 2024-01-08
- fix: Try fixed version. 2024-01-08
- fix: Update dll paths in OpenApiGenerator project 2024-01-08