OpenApiGenerator.Cli
0.7.2
dotnet tool install --global OpenApiGenerator.Cli --version 0.7.2
dotnet new tool-manifest # if you are setting up this repo dotnet tool install --local OpenApiGenerator.Cli --version 0.7.2
#tool dotnet:?package=OpenApiGenerator.Cli&version=0.7.2
nuke :add-package OpenApiGenerator.Cli --version 0.7.2
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:
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.
Trimming support
Since there are two source generators involved, we will have to create a second project so that the generator for the JsonSerializerContext will “see” our models
- Create new project for your models. And disable methods/constructors generation:
<PropertyGroup Label="OpenApiGenerator">
<OpenApiGenerator_GenerateSdk>false</OpenApiGenerator_GenerateSdk>
<OpenApiGenerator_GenerateModels>true</OpenApiGenerator_GenerateModels>
<OpenApiGenerator_GenerateSuperTypeForJsonSerializerContext>true</OpenApiGenerator_GenerateSuperTypeForJsonSerializerContext>
</PropertyGroup>
- Reference this project in your main project.
- Add
SourceGenerationContext.cs
file to your main project with the following content:
using System.Text.Json.Serialization;
namespace Namespace;
[JsonSourceGenerationOptions(DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull)]
[JsonSerializable(typeof(OpenApiGeneratorTrimmableSupport))]
internal sealed partial class SourceGenerationContext : JsonSerializerContext;
- Add the following settings to your main csproj file:
<PropertyGroup Label="OpenApiGenerator">
<OpenApiGenerator_GenerateSdk>false</OpenApiGenerator_GenerateSdk>
<OpenApiGenerator_GenerateMethods>true</OpenApiGenerator_GenerateMethods>
<OpenApiGenerator_GenerateConstructors>true</OpenApiGenerator_GenerateConstructors>
<OpenApiGenerator_JsonSerializerContext>Namespace.SourceGenerationContext</OpenApiGenerator_JsonSerializerContext>
</PropertyGroup>
- Add these settings to your new and main csproj file to enable trimming(or use Directory.Build.props file):
<PropertyGroup Label="Trimmable" Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net6.0'))">
<IsAotCompatible>true</IsAotCompatible>
<EnableTrimAnalyzer>true</EnableTrimAnalyzer>
<IsTrimmable>true</IsTrimmable>
<SuppressTrimAnalysisWarnings>false</SuppressTrimAnalysisWarnings>
<TrimmerSingleWarn>false</TrimmerSingleWarn>
</PropertyGroup>
- It's all! Now you can build your project and use the generated code with full trimming/nativeAOT support.
📚Examples of use in real SDKs📚
Product | Versions 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. |
This package has no dependencies.
Version | Downloads | Last updated |
---|---|---|
0.7.2 | 37 | 5/23/2024 |
0.7.1 | 36 | 5/22/2024 |
0.7.0 | 43 | 5/22/2024 |
0.6.9 | 39 | 5/22/2024 |
0.6.8 | 68 | 5/21/2024 |
0.6.7 | 72 | 5/21/2024 |
0.6.6 | 71 | 5/19/2024 |
0.6.5 | 67 | 5/19/2024 |
0.6.4 | 62 | 5/19/2024 |
0.6.3 | 65 | 5/19/2024 |
0.6.2 | 65 | 5/19/2024 |
0.6.1 | 64 | 5/19/2024 |
0.6.0 | 64 | 5/19/2024 |
0.5.0 | 71 | 5/19/2024 |
0.4.0 | 73 | 5/19/2024 |
0.3.2 | 64 | 5/13/2024 |
0.3.1 | 60 | 5/13/2024 |
0.3.0 | 55 | 5/13/2024 |
0.2.0 | 61 | 5/11/2024 |
⭐ Last 10 features:
- feat: Added GroupByTags setting. 2024-05-23
- feat: Added Authorize methods. 2024-05-22
- feat: Added IncludeTags/ExcludeTags settings. 2024-05-22
- feat: Added MethodNamingConvention support. 2024-05-21
- feat: Added GenerateSuperTypeForJsonSerializerContext. 2024-05-19
- 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
🐞 Last 10 bug fixes:
- fix: Fixed some issues with special characters in names. 2024-05-23
- fix: Fixed Authorize method names. 2024-05-22
- fix: Fixed parameter default values. 2024-05-22
- fix: Fixed generation of empty classes for object type without any additional info. 2024-05-22
- fix: Fixed missing HttpMethod.Patch in Net Framework/Net Standard. 2024-05-22
- fix: Fixed generation for implicit array enums. 2024-05-21
- fix: Fixed issue with incorrect request type names. 2024-05-21
- fix: Fixed .json/url generation. 2024-05-21
- fix: Fixed incorrect requestUri generation. 2024-05-19
- fix: Fixed docs warning. 2024-05-19