OpenApiGenerator.Cli 0.5.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.5.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.5.0                
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=OpenApiGenerator.Cli&version=0.5.0                
nuke :add-package OpenApiGenerator.Cli --version 0.5.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 optional settings to your csproj file to customize generation. 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_GenerateSdk>false</OpenApiGenerator_GenerateSdk>
    <OpenApiGenerator_GenerateModels>true</OpenApiGenerator_GenerateModels>
    <OpenApiGenerator_GenerateMethods>true</OpenApiGenerator_GenerateMethods>
    <OpenApiGenerator_GenerateConstructors>true</OpenApiGenerator_GenerateConstructors>
    <OpenApiGenerator_IncludeOperationIds>getPet;deletePet</OpenApiGenerator_IncludeOperationIds>
    <OpenApiGenerator_ExcludeOperationIds>getPet;deletePet</OpenApiGenerator_ExcludeOperationIds>
    <OpenApiGenerator_IncludeModels>Pet;Model</OpenApiGenerator_IncludeModels>
    <OpenApiGenerator_ExcludeModels>Pet;Model</OpenApiGenerator_ExcludeModels>
</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,119 9/9/2024 0.22.6-dev.7 is deprecated because it is no longer maintained.
0.22.6-dev.6 44 9/9/2024 0.22.6-dev.6 is deprecated because it is no longer maintained.
0.22.6-dev.4 213 9/7/2024 0.22.6-dev.4 is deprecated because it is no longer maintained.
0.22.6-dev.2 73 9/7/2024 0.22.6-dev.2 is deprecated because it is no longer maintained.
0.22.6-dev.1 42 9/7/2024 0.22.6-dev.1 is deprecated because it is no longer maintained.
0.22.5 101 9/7/2024 0.22.5 is deprecated because it is no longer maintained.
0.22.4 76 9/7/2024 0.22.4 is deprecated because it is no longer maintained.
0.22.3 75 9/7/2024 0.22.3 is deprecated because it is no longer maintained.
0.22.2 88 9/7/2024 0.22.2 is deprecated because it is no longer maintained.
0.22.1 76 9/7/2024 0.22.1 is deprecated because it is no longer maintained.
0.22.0 74 9/7/2024 0.22.0 is deprecated because it is no longer maintained.
0.21.1 136 9/6/2024 0.21.1 is deprecated because it is no longer maintained.
0.21.0 80 9/6/2024 0.21.0 is deprecated because it is no longer maintained.
0.20.2 709 8/31/2024 0.20.2 is deprecated because it is no longer maintained.
0.20.1 85 8/31/2024 0.20.1 is deprecated because it is no longer maintained.
0.20.0 83 8/30/2024 0.20.0 is deprecated because it is no longer maintained.
0.19.0 105 8/30/2024 0.19.0 is deprecated because it is no longer maintained.
0.18.0 187 8/29/2024 0.18.0 is deprecated because it is no longer maintained.
0.17.1 114 8/28/2024 0.17.1 is deprecated because it is no longer maintained.
0.17.0 90 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 443 8/24/2024 0.16.3 is deprecated because it is no longer maintained.
0.16.2 115 8/24/2024 0.16.2 is deprecated because it is no longer maintained.
0.16.1 186 8/23/2024 0.16.1 is deprecated because it is no longer maintained.
0.16.0 160 8/22/2024 0.16.0 is deprecated because it is no longer maintained.
0.15.8 113 8/22/2024 0.15.8 is deprecated because it is no longer maintained.
0.15.7 240 8/19/2024 0.15.7 is deprecated because it is no longer maintained.
0.15.6 156 8/18/2024 0.15.6 is deprecated because it is no longer maintained.
0.15.5 102 8/18/2024 0.15.5 is deprecated because it is no longer maintained.
0.15.4 219 8/15/2024 0.15.4 is deprecated because it is no longer maintained.
0.15.3 163 8/13/2024 0.15.3 is deprecated because it is no longer maintained.
0.15.2 133 8/13/2024 0.15.2 is deprecated because it is no longer maintained.
0.15.1 121 8/12/2024 0.15.1 is deprecated because it is no longer maintained.
0.15.0 128 8/11/2024 0.15.0 is deprecated because it is no longer maintained.
0.14.3 236 8/6/2024 0.14.3 is deprecated because it is no longer maintained.
0.14.2 66 8/5/2024 0.14.2 is deprecated because it is no longer maintained.
0.14.1 52 8/5/2024 0.14.1 is deprecated because it is no longer maintained.
0.14.0 46 8/5/2024 0.14.0 is deprecated because it is no longer maintained.
0.13.11 366 7/22/2024 0.13.11 is deprecated because it is no longer maintained.
0.13.10 111 7/21/2024 0.13.10 is deprecated because it is no longer maintained.
0.13.9 113 7/18/2024 0.13.9 is deprecated because it is no longer maintained.
0.13.8 100 7/15/2024 0.13.8 is deprecated because it is no longer maintained.
0.13.7 83 7/15/2024 0.13.7 is deprecated because it is no longer maintained.
0.13.6 91 7/14/2024 0.13.6 is deprecated because it is no longer maintained.
0.13.5 84 7/14/2024 0.13.5 is deprecated because it is no longer maintained.
0.13.4 88 7/13/2024 0.13.4 is deprecated because it is no longer maintained.
0.13.3 103 7/9/2024 0.13.3 is deprecated because it is no longer maintained.
0.13.2 74 7/8/2024 0.13.2 is deprecated because it is no longer maintained.
0.13.1 84 7/8/2024 0.13.1 is deprecated because it is no longer maintained.
0.13.0 88 7/8/2024 0.13.0 is deprecated because it is no longer maintained.
0.12.2 90 7/8/2024 0.12.2 is deprecated because it is no longer maintained.
0.12.1 107 7/6/2024 0.12.1 is deprecated because it is no longer maintained.
0.12.0 97 7/6/2024 0.12.0 is deprecated because it is no longer maintained.
0.11.11 90 7/6/2024 0.11.11 is deprecated because it is no longer maintained.
0.11.10 86 7/6/2024 0.11.10 is deprecated because it is no longer maintained.
0.11.9 121 6/30/2024 0.11.9 is deprecated because it is no longer maintained.
0.11.8 97 6/30/2024 0.11.8 is deprecated because it is no longer maintained.
0.11.7 98 6/30/2024 0.11.7 is deprecated because it is no longer maintained.
0.11.6 103 6/29/2024 0.11.6 is deprecated because it is no longer maintained.
0.11.4 90 6/27/2024 0.11.4 is deprecated because it is no longer maintained.
0.11.3 101 6/27/2024 0.11.3 is deprecated because it is no longer maintained.
0.11.1 91 6/20/2024 0.11.1 is deprecated because it is no longer maintained.
0.11.0 98 6/16/2024 0.11.0 is deprecated because it is no longer maintained.
0.10.8 98 6/15/2024 0.10.8 is deprecated because it is no longer maintained.
0.10.7 100 6/15/2024 0.10.7 is deprecated because it is no longer maintained.
0.10.6 90 6/15/2024 0.10.6 is deprecated because it is no longer maintained.
0.10.4 91 6/13/2024 0.10.4 is deprecated because it is no longer maintained.
0.10.2 88 6/13/2024 0.10.2 is deprecated because it is no longer maintained.
0.10.1 85 6/13/2024 0.10.1 is deprecated because it is no longer maintained.
0.10.0 90 6/13/2024 0.10.0 is deprecated because it is no longer maintained.
0.9.12 95 6/6/2024 0.9.12 is deprecated because it is no longer maintained.
0.9.11 85 6/6/2024 0.9.11 is deprecated because it is no longer maintained.
0.9.10 90 6/5/2024 0.9.10 is deprecated because it is no longer maintained.
0.9.9 89 6/5/2024 0.9.9 is deprecated because it is no longer maintained.
0.9.8 90 6/4/2024 0.9.8 is deprecated because it is no longer maintained.
0.9.7 108 6/1/2024 0.9.7 is deprecated because it is no longer maintained.
0.9.5 97 5/31/2024 0.9.5 is deprecated because it is no longer maintained.
0.9.4 98 5/31/2024 0.9.4 is deprecated because it is no longer maintained.
0.9.3 96 5/31/2024 0.9.3 is deprecated because it is no longer maintained.
0.9.1 97 5/30/2024 0.9.1 is deprecated because it is no longer maintained.
0.9.0 91 5/30/2024 0.9.0 is deprecated because it is no longer maintained.
0.8.8 93 5/28/2024 0.8.8 is deprecated because it is no longer maintained.
0.8.6 92 5/27/2024 0.8.6 is deprecated because it is no longer maintained.
0.8.5 92 5/27/2024 0.8.5 is deprecated because it is no longer maintained.
0.8.4 97 5/27/2024 0.8.4 is deprecated because it is no longer maintained.
0.8.3 97 5/27/2024 0.8.3 is deprecated because it is no longer maintained.
0.8.1 113 5/25/2024 0.8.1 is deprecated because it is no longer maintained.
0.8.0 104 5/25/2024 0.8.0 is deprecated because it is no longer maintained.
0.7.2 105 5/23/2024 0.7.2 is deprecated because it is no longer maintained.
0.7.1 101 5/22/2024 0.7.1 is deprecated because it is no longer maintained.
0.7.0 105 5/22/2024 0.7.0 is deprecated because it is no longer maintained.
0.6.9 98 5/22/2024 0.6.9 is deprecated because it is no longer maintained.
0.6.8 98 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 99 5/19/2024 0.6.6 is deprecated because it is no longer maintained.
0.6.5 94 5/19/2024 0.6.5 is deprecated because it is no longer maintained.
0.6.4 91 5/19/2024 0.6.4 is deprecated because it is no longer maintained.
0.6.3 92 5/19/2024 0.6.3 is deprecated because it is no longer maintained.
0.6.2 93 5/19/2024 0.6.2 is deprecated because it is no longer maintained.
0.6.1 91 5/19/2024 0.6.1 is deprecated because it is no longer maintained.
0.6.0 89 5/19/2024 0.6.0 is deprecated because it is no longer maintained.
0.5.0 100 5/19/2024 0.5.0 is deprecated because it is no longer maintained.
0.4.0 99 5/19/2024 0.4.0 is deprecated because it is no longer maintained.
0.3.2 88 5/13/2024 0.3.2 is deprecated because it is no longer maintained.
0.3.1 88 5/13/2024 0.3.1 is deprecated because it is no longer maintained.
0.3.0 76 5/13/2024 0.3.0 is deprecated because it is no longer maintained.
0.2.0 85 5/11/2024 0.2.0 is deprecated because it is no longer maintained.

⭐ Last 10 features:
- feat: Added trimming support. 2024-05-19
- feat: Now it generates full sdk by default. 2024-05-19
- feat: Added enum support for query/path parameters. 2024-05-19
- feat: Added generation of models from parameters. 2024-05-19
- feat: Added ability to serialize different types of parameters. 2024-05-19
- feat: Added initial support of query parameters. 2024-05-18
- feat: Added path parameters support. 2024-05-17
- 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
🐞 Last 10 bug fixes:
- fix: Fixed GetCSharpType parents Last() calls. 2024-05-17
- fix: Fixed issue with array of child items of same type. 2024-05-17
- fix: Fixed issue with {} as default value. 2024-05-17
- 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