OpenApiGenerator.Core
0.3.1
.NET 6.0
This package targets .NET 6.0. The package is compatible with this framework or higher.
.NET Standard 2.0
This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
.NET Framework 4.6.2
This package targets .NET Framework 4.6.2. The package is compatible with this framework or higher.
Suggested Alternatives
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package OpenApiGenerator.Core --version 0.3.1
NuGet\Install-Package OpenApiGenerator.Core -Version 0.3.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="OpenApiGenerator.Core" Version="0.3.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add OpenApiGenerator.Core --version 0.3.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: OpenApiGenerator.Core, 0.3.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install OpenApiGenerator.Core as a Cake Addin #addin nuget:?package=OpenApiGenerator.Core&version=0.3.1 // Install OpenApiGenerator.Core as a Cake Tool #tool nuget:?package=OpenApiGenerator.Core&version=0.3.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
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:
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 | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. 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. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 is compatible. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETFramework 4.6.2
- Microsoft.OpenApi.Readers (>= 1.6.14)
- System.Collections.Immutable (>= 8.0.0)
-
.NETStandard 2.0
- Microsoft.OpenApi.Readers (>= 1.6.14)
- System.Collections.Immutable (>= 8.0.0)
-
net6.0
- Microsoft.OpenApi.Readers (>= 1.6.14)
- System.Collections.Immutable (>= 8.0.0)
-
net8.0
- Microsoft.OpenApi.Readers (>= 1.6.14)
- System.Collections.Immutable (>= 8.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last updated | |
|---|---|---|---|
| 0.22.6-dev.7 | 177 | 9/9/2024 | |
| 0.22.6-dev.6 | 66 | 9/9/2024 | |
| 0.22.6-dev.4 | 70 | 9/7/2024 | |
| 0.22.6-dev.2 | 61 | 9/7/2024 | |
| 0.22.6-dev.1 | 60 | 9/7/2024 | |
| 0.22.5 | 125 | 9/7/2024 | |
| 0.22.4 | 102 | 9/7/2024 | |
| 0.22.3 | 108 | 9/7/2024 | |
| 0.22.2 | 112 | 9/7/2024 | |
| 0.22.1 | 104 | 9/7/2024 | |
| 0.22.0 | 103 | 9/7/2024 | |
| 0.21.1 | 107 | 9/6/2024 | |
| 0.21.0 | 105 | 9/6/2024 | |
| 0.20.2 | 125 | 8/31/2024 | |
| 0.20.1 | 106 | 8/31/2024 | |
| 0.20.0 | 108 | 8/30/2024 | |
| 0.19.0 | 119 | 8/30/2024 | |
| 0.18.0 | 113 | 8/29/2024 | |
| 0.17.1 | 125 | 8/28/2024 | |
| 0.17.0 | 128 | 8/28/2024 | |
| 0.16.4-dev.7 | 61 | 8/28/2024 | |
| 0.16.3 | 149 | 8/24/2024 | |
| 0.16.2 | 135 | 8/24/2024 | |
| 0.16.1 | 137 | 8/23/2024 | |
| 0.16.0 | 149 | 8/22/2024 | |
| 0.15.8 | 150 | 8/22/2024 | |
| 0.15.7 | 140 | 8/19/2024 | |
| 0.15.6 | 136 | 8/18/2024 | |
| 0.15.5 | 130 | 8/18/2024 | |
| 0.15.4 | 129 | 8/15/2024 | |
| 0.15.3 | 133 | 8/13/2024 | |
| 0.15.2 | 128 | 8/13/2024 | |
| 0.15.1 | 128 | 8/12/2024 | |
| 0.15.0 | 136 | 8/11/2024 | |
| 0.14.3 | 74 | 8/6/2024 | |
| 0.14.2 | 74 | 8/5/2024 | |
| 0.14.1 | 82 | 8/5/2024 | |
| 0.14.0 | 75 | 8/5/2024 | |
| 0.13.11 | 122 | 7/22/2024 | |
| 0.13.10 | 136 | 7/21/2024 | |
| 0.13.9 | 112 | 7/18/2024 | |
| 0.13.8 | 120 | 7/15/2024 | |
| 0.13.7 | 114 | 7/15/2024 | |
| 0.13.6 | 117 | 7/14/2024 | |
| 0.13.5 | 109 | 7/14/2024 | |
| 0.13.4 | 110 | 7/13/2024 | |
| 0.13.3 | 113 | 7/9/2024 | |
| 0.13.2 | 113 | 7/8/2024 | |
| 0.13.1 | 119 | 7/8/2024 | |
| 0.13.0 | 105 | 7/8/2024 | |
| 0.12.2 | 124 | 7/8/2024 | |
| 0.12.1 | 122 | 7/6/2024 | |
| 0.12.0 | 117 | 7/6/2024 | |
| 0.11.11 | 120 | 7/6/2024 | |
| 0.11.10 | 119 | 7/6/2024 | |
| 0.11.9 | 134 | 6/30/2024 | |
| 0.11.8 | 136 | 6/30/2024 | |
| 0.11.7 | 127 | 6/30/2024 | |
| 0.11.6 | 122 | 6/29/2024 | |
| 0.11.4 | 144 | 6/27/2024 | |
| 0.11.3 | 131 | 6/27/2024 | |
| 0.11.1 | 117 | 6/20/2024 | |
| 0.11.0 | 133 | 6/16/2024 | |
| 0.10.8 | 126 | 6/15/2024 | |
| 0.10.7 | 130 | 6/15/2024 | |
| 0.10.6 | 119 | 6/15/2024 | |
| 0.10.4 | 114 | 6/13/2024 | |
| 0.10.2 | 113 | 6/13/2024 | |
| 0.10.1 | 108 | 6/13/2024 | |
| 0.10.0 | 115 | 6/13/2024 | |
| 0.9.12 | 122 | 6/6/2024 | |
| 0.9.11 | 116 | 6/6/2024 | |
| 0.9.10 | 122 | 6/5/2024 | |
| 0.9.9 | 116 | 6/5/2024 | |
| 0.9.8 | 120 | 6/4/2024 | |
| 0.9.7 | 124 | 6/1/2024 | |
| 0.9.5 | 134 | 5/31/2024 | |
| 0.9.4 | 126 | 5/31/2024 | |
| 0.9.3 | 120 | 5/31/2024 | |
| 0.9.1 | 128 | 5/30/2024 | |
| 0.9.0 | 124 | 5/30/2024 | |
| 0.8.8 | 124 | 5/28/2024 | |
| 0.8.6 | 108 | 5/27/2024 | |
| 0.8.5 | 118 | 5/27/2024 | |
| 0.8.4 | 130 | 5/27/2024 | |
| 0.8.3 | 122 | 5/27/2024 | |
| 0.8.1 | 136 | 5/25/2024 | |
| 0.8.0 | 125 | 5/25/2024 | |
| 0.7.2 | 136 | 5/23/2024 | |
| 0.7.1 | 133 | 5/22/2024 | |
| 0.7.0 | 127 | 5/22/2024 | |
| 0.6.9 | 124 | 5/22/2024 | |
| 0.6.8 | 128 | 5/21/2024 | |
| 0.6.7 | 124 | 5/21/2024 | |
| 0.6.6 | 125 | 5/19/2024 | |
| 0.6.5 | 122 | 5/19/2024 | |
| 0.6.4 | 120 | 5/19/2024 | |
| 0.6.3 | 126 | 5/19/2024 | |
| 0.6.2 | 120 | 5/19/2024 | |
| 0.6.1 | 131 | 5/19/2024 | |
| 0.6.0 | 124 | 5/19/2024 | |
| 0.5.0 | 137 | 5/19/2024 | |
| 0.4.0 | 126 | 5/19/2024 | |
| 0.3.2 | 131 | 5/13/2024 | |
| 0.3.1 | 124 | 5/13/2024 | |
| 0.3.0 | 129 | 5/13/2024 | |
| 0.2.0 | 139 | 5/11/2024 | |
| 0.1.5 | 132 | 5/10/2024 | |
| 0.1.4 | 125 | 5/10/2024 | |
| 0.1.3 | 156 | 4/5/2024 |
⭐ Last 10 features:
- 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
- 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
🐞 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