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,760 9/9/2024 0.22.6-dev.7 is deprecated because it is no longer maintained.
0.22.6-dev.6 170 9/9/2024 0.22.6-dev.6 is deprecated because it is no longer maintained.
0.22.6-dev.4 356 9/7/2024 0.22.6-dev.4 is deprecated because it is no longer maintained.
0.22.6-dev.2 211 9/7/2024 0.22.6-dev.2 is deprecated because it is no longer maintained.
0.22.6-dev.1 191 9/7/2024 0.22.6-dev.1 is deprecated because it is no longer maintained.
0.22.5 685 9/7/2024 0.22.5 is deprecated because it is no longer maintained.
0.22.4 262 9/7/2024 0.22.4 is deprecated because it is no longer maintained.
0.22.3 269 9/7/2024 0.22.3 is deprecated because it is no longer maintained.
0.22.2 269 9/7/2024 0.22.2 is deprecated because it is no longer maintained.
0.22.1 288 9/7/2024 0.22.1 is deprecated because it is no longer maintained.
0.22.0 266 9/7/2024 0.22.0 is deprecated because it is no longer maintained.
0.21.1 332 9/6/2024 0.21.1 is deprecated because it is no longer maintained.
0.21.0 283 9/6/2024 0.21.0 is deprecated because it is no longer maintained.
0.20.2 900 8/31/2024 0.20.2 is deprecated because it is no longer maintained.
0.20.1 251 8/31/2024 0.20.1 is deprecated because it is no longer maintained.
0.20.0 288 8/30/2024 0.20.0 is deprecated because it is no longer maintained.
0.19.0 264 8/30/2024 0.19.0 is deprecated because it is no longer maintained.
0.18.0 364 8/29/2024 0.18.0 is deprecated because it is no longer maintained.
0.17.1 294 8/28/2024 0.17.1 is deprecated because it is no longer maintained.
0.3.0 236 5/13/2024 0.3.0 is deprecated because it is no longer maintained.
Loading failed

⭐ 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