OpenApiGenerator.Cli 0.5.0

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.10.8 8 6/15/2024
0.10.7 32 6/15/2024
0.10.6 25 6/15/2024
0.10.4 36 6/13/2024
0.10.2 32 6/13/2024
0.10.1 29 6/13/2024
0.10.0 35 6/13/2024
0.9.12 67 6/6/2024
0.9.11 60 6/6/2024
0.9.10 66 6/5/2024
0.9.9 62 6/5/2024
0.9.8 66 6/4/2024
0.9.7 83 6/1/2024
0.9.5 71 5/31/2024
0.9.4 75 5/31/2024
0.9.3 73 5/31/2024
0.9.1 76 5/30/2024
0.9.0 70 5/30/2024
0.8.8 71 5/28/2024
0.8.6 70 5/27/2024
0.8.5 70 5/27/2024
0.8.4 75 5/27/2024
0.8.3 76 5/27/2024
0.8.1 88 5/25/2024
0.8.0 81 5/25/2024
0.7.2 80 5/23/2024
0.7.1 76 5/22/2024
0.7.0 82 5/22/2024
0.6.9 75 5/22/2024
0.6.8 74 5/21/2024
0.6.7 78 5/21/2024
0.6.6 76 5/19/2024
0.6.5 72 5/19/2024
0.6.4 67 5/19/2024
0.6.3 70 5/19/2024
0.6.2 70 5/19/2024
0.6.1 69 5/19/2024
0.6.0 69 5/19/2024
0.5.0 77 5/19/2024
0.4.0 79 5/19/2024
0.3.2 69 5/13/2024
0.3.1 63 5/13/2024
0.3.0 59 5/13/2024
0.2.0 65 5/11/2024

⭐ 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