AutoSDK 0.27.1-dev.37
.NET 8.0
This package targets .NET 8.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.
This is a prerelease version of AutoSDK.
dotnet add package AutoSDK --version 0.27.1-dev.37
NuGet\Install-Package AutoSDK -Version 0.27.1-dev.37
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="AutoSDK" Version="0.27.1-dev.37" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AutoSDK --version 0.27.1-dev.37
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: AutoSDK, 0.27.1-dev.37"
#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 AutoSDK as a Cake Addin #addin nuget:?package=AutoSDK&version=0.27.1-dev.37&prerelease // Install AutoSDK as a Cake Tool #tool nuget:?package=AutoSDK&version=0.27.1-dev.37&prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
AutoSDK
The goal of this project is to automate and minimize the effort of maintaining high-quality .NET SDKs generated based on the OpenAPI specification, mainly to strengthen the AI ecosystem within .NET. The code generated by this library is also actively used in dozens of our various SDKs of varying complexity levels and in the LangChain.NET project, which ensures that it is tested in various scenarios and is ready for them.
Inspired by NSwag ❤️.
🔥Features🔥
- Detects your TargetFramework and generates optimal code for it (including net6.0/net7.0/net8.0 improvements)
- Supports .Net Framework/.Net Standard
- Supports OpenAPI 3.1 specs via internal conversion to OpenAPI 3.0 (includes support for nullability, examples, const)
- 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 nullable enable/trimming/native AOT compilation/CLS compliance
- Tested on GitHub 220k lines OpenAPI specification
- Supports OneOf/AnyOf/AllOf/Not schemas
- Supports Enums for System.Text.Json
- Supports SSE (Server-Sent Events) through the
application/x-ndjsoncontent type - Uses Incremental Source Generators for efficient generation and caching.
- Efficient O(n) implementation, fully suitable for large/super large OpenAPI specifications
- Used in 10+ real SDKs and adapted to solve various problems
🚀Quick start🚀
CLI (Recommended)
You can use the CLI to generate the code.
dotnet tool install --global autosdk.cli --prerelease
rm -rf Generated
autosdk generate openapi.yaml \
--namespace Namespace \
--clientClassName YourApi \
--targetFramework net8.0 \
--output Generated
It will generate the code in the "Generated" subdirectory.
It also will include polyfills for .Net Framework/.Net Standard TargetFrameworks.
Source generator
- Install the package
dotnet add package AutoSDK.SourceGenerators
- Add the following optional settings to your csproj file to customize generation. You can check all settings here:
<ItemGroup Label="AutoSDK">
<AdditionalFiles Include="$(MSBuildThisFileDirectory)../../../docs/openapi.yaml" />
</ItemGroup>
<PropertyGroup Label="AutoSDK">
<AutoSDK_Namespace>Ollama</AutoSDK_Namespace>
<AutoSDK_ClassName>OllamaApi</AutoSDK_ClassName>
<AutoSDK_GenerateSdk>false</AutoSDK_GenerateSdk>
<AutoSDK_GenerateModels>true</AutoSDK_GenerateModels>
<AutoSDK_GenerateMethods>true</AutoSDK_GenerateMethods>
<AutoSDK_GenerateConstructors>true</AutoSDK_GenerateConstructors>
<AutoSDK_IncludeOperationIds>getPet;deletePet</AutoSDK_IncludeOperationIds>
<AutoSDK_ExcludeOperationIds>getPet;deletePet</AutoSDK_ExcludeOperationIds>
<AutoSDK_IncludeModels>Pet;Model</AutoSDK_IncludeModels>
<AutoSDK_ExcludeModels>Pet;Model</AutoSDK_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:
Trimming support
CLI
CLI generates Trimming/NativeAOT compatible code by default.
Source generator
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="AutoSDK">
<AutoSDK_GenerateSdk>false</AutoSDK_GenerateSdk>
<AutoSDK_GenerateModels>true</AutoSDK_GenerateModels>
<AutoSDK_GenerateJsonSerializerContextTypes>true</AutoSDK_GenerateJsonSerializerContextTypes>
</PropertyGroup>
- Reference this project in your main project.
- Add
SourceGenerationContext.csfile to your main project with the following content:
using System.Text.Json.Serialization;
namespace Namespace;
[JsonSourceGenerationOptions(DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull)]
[JsonSerializable(typeof(AutoSDKTrimmableSupport))]
internal sealed partial class SourceGenerationContext : JsonSerializerContext;
- Add the following settings to your main csproj file:
<PropertyGroup Label="AutoSDK">
<AutoSDK_GenerateSdk>false</AutoSDK_GenerateSdk>
<AutoSDK_GenerateMethods>true</AutoSDK_GenerateMethods>
<AutoSDK_GenerateConstructors>true</AutoSDK_GenerateConstructors>
<AutoSDK_JsonSerializerContext>Namespace.SourceGenerationContext</AutoSDK_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 | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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. net9.0 is compatible. |
| .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.22)
- System.Collections.Immutable (>= 8.0.0)
- System.Text.Json (>= 8.0.5)
-
.NETStandard 2.0
- Microsoft.OpenApi.Readers (>= 1.6.22)
- System.Collections.Immutable (>= 8.0.0)
- System.Text.Json (>= 8.0.5)
-
net8.0
- Microsoft.OpenApi.Readers (>= 1.6.22)
- System.Collections.Immutable (>= 8.0.0)
- System.Text.Json (>= 8.0.5)
-
net9.0
- Microsoft.OpenApi.Readers (>= 1.6.22)
- System.Collections.Immutable (>= 8.0.0)
- System.Text.Json (>= 8.0.5)
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.27.1-dev.37 | 30 | 11/19/2024 |
| 0.27.1-dev.35 | 96 | 11/14/2024 |
| 0.27.1-dev.33 | 31 | 11/13/2024 |
| 0.27.1-dev.32 | 27 | 11/13/2024 |
| 0.27.1-dev.30 | 33 | 11/13/2024 |
| 0.27.1-dev.26 | 32 | 11/13/2024 |
| 0.27.1-dev.25 | 32 | 11/13/2024 |
| 0.27.1-dev.22 | 85 | 11/12/2024 |
| 0.27.1-dev.21 | 32 | 11/12/2024 |
| 0.27.1-dev.20 | 32 | 11/12/2024 |
| 0.27.1-dev.9 | 178 | 11/6/2024 |
| 0.27.1-dev.3 | 43 | 11/2/2024 |
| 0.27.1-dev.2 | 34 | 11/2/2024 |
| 0.27.0 | 1,424 | 10/30/2024 |
| 0.26.1-dev.73 | 523 | 10/26/2024 |
| 0.26.1-dev.70 | 71 | 10/24/2024 |
| 0.26.1-dev.68 | 35 | 10/24/2024 |
| 0.26.1-dev.67 | 37 | 10/24/2024 |
| 0.26.1-dev.66 | 37 | 10/24/2024 |
| 0.26.1-dev.65 | 34 | 10/24/2024 |
| 0.26.1-dev.64 | 36 | 10/22/2024 |
| 0.26.1-dev.63 | 39 | 10/22/2024 |
| 0.26.1-dev.61 | 445 | 10/18/2024 |
| 0.26.1-dev.60 | 84 | 10/18/2024 |
| 0.26.1-dev.58 | 37 | 10/18/2024 |
| 0.26.1-dev.53 | 57 | 10/16/2024 |
| 0.26.1-dev.46 | 398 | 10/13/2024 |
| 0.26.1-dev.45 | 41 | 10/13/2024 |
| 0.26.1-dev.44 | 37 | 10/13/2024 |
| 0.26.1-dev.42 | 87 | 10/12/2024 |
| 0.26.1-dev.37 | 72 | 10/12/2024 |
| 0.26.1-dev.36 | 38 | 10/12/2024 |
| 0.26.1-dev.33 | 44 | 10/11/2024 |
| 0.26.1-dev.32 | 48 | 10/11/2024 |
| 0.26.1-dev.29 | 41 | 10/11/2024 |
| 0.26.1-dev.28 | 39 | 10/11/2024 |
| 0.26.1-dev.27 | 43 | 10/11/2024 |
| 0.26.1-dev.25 | 46 | 10/11/2024 |
| 0.26.1-dev.24 | 40 | 10/11/2024 |
| 0.26.1-dev.17 | 45 | 10/8/2024 |
| 0.26.1-dev.13 | 118 | 10/3/2024 |
| 0.26.1-dev.12 | 43 | 10/3/2024 |
| 0.26.1-dev.11 | 997 | 10/3/2024 |
| 0.26.1-dev.10 | 43 | 10/3/2024 |
| 0.26.1-dev.9 | 41 | 10/3/2024 |
| 0.26.1-dev.4 | 40 | 10/1/2024 |
| 0.26.1-dev.3 | 33 | 10/1/2024 |
| 0.26.1-dev.2 | 38 | 10/1/2024 |
| 0.26.1-dev.1 | 46 | 10/1/2024 |
| 0.26.0 | 84 | 10/1/2024 |
| 0.25.0 | 91 | 10/1/2024 |
| 0.24.1-dev.68 | 48 | 10/1/2024 |
| 0.24.1-dev.67 | 45 | 10/1/2024 |
| 0.24.1-dev.66 | 47 | 10/1/2024 |
| 0.24.1-dev.56 | 47 | 9/23/2024 |
| 0.24.1-dev.54 | 41 | 9/22/2024 |
| 0.24.1-dev.53 | 44 | 9/22/2024 |
| 0.24.1-dev.52 | 46 | 9/22/2024 |
| 0.24.1-dev.51 | 44 | 9/22/2024 |
| 0.24.1-dev.50 | 41 | 9/22/2024 |
| 0.24.1-dev.49 | 46 | 9/22/2024 |
| 0.24.1-dev.47 | 44 | 9/22/2024 |
| 0.24.1-dev.44 | 47 | 9/21/2024 |
| 0.24.1-dev.41 | 49 | 9/20/2024 |
| 0.24.1-dev.40 | 43 | 9/20/2024 |
| 0.24.1-dev.39 | 41 | 9/20/2024 |
| 0.24.1-dev.33 | 61 | 9/17/2024 |
| 0.24.1-dev.31 | 38 | 9/17/2024 |
| 0.24.1-dev.28 | 59 | 9/15/2024 |
| 0.24.1-dev.27 | 51 | 9/15/2024 |
| 0.24.1-dev.26 | 52 | 9/14/2024 |
| 0.24.1-dev.25 | 51 | 9/14/2024 |
| 0.24.1-dev.24 | 45 | 9/12/2024 |
| 0.24.1-dev.23 | 45 | 9/12/2024 |
| 0.24.1-dev.22 | 55 | 9/11/2024 |
| 0.24.1-dev.19 | 49 | 9/11/2024 |
| 0.24.1-dev.18 | 46 | 9/11/2024 |
| 0.24.1-dev.15 | 52 | 9/11/2024 |
| 0.24.1-dev.14 | 48 | 9/11/2024 |
| 0.24.1-dev.13 | 47 | 9/11/2024 |
| 0.24.1-dev.11 | 58 | 9/11/2024 |
| 0.24.1-dev.10 | 49 | 9/11/2024 |
| 0.24.1-dev.9 | 48 | 9/11/2024 |
| 0.24.1-dev.8 | 47 | 9/11/2024 |
| 0.24.1-dev.7 | 52 | 9/11/2024 |
| 0.24.1-dev.2 | 52 | 9/10/2024 |
| 0.24.1-dev.1 | 50 | 9/10/2024 |
| 0.24.0 | 111 | 9/10/2024 |
| 0.23.1-dev.3 | 51 | 9/10/2024 |
| 0.23.1-dev.2 | 51 | 9/10/2024 |
| 0.23.1-dev.1 | 52 | 9/9/2024 |
| 0.23.0 | 117 | 9/9/2024 |
| 0.22.6-dev.10 | 61 | 9/9/2024 |
⭐ Last 10 features:
- feat: Updated to net9. 2024-11-13
- feat: Replaced AnyOf JsonConverterFactory with explicit generic converters. 2024-11-13
- feat(cli): Use net9 in sln template. 2024-11-13
- feat: Added support for default responses. 2024-11-12
- feat: Initial support for non success responses(through exceptions) 2024-11-12
- feat: Initial work for System.ComponentModel.Annotations support. 2024-11-12
- feat: Added default/example block to xml doc. 2024-11-12
- feat: Added constructors with all values besides parameterless. 2024-11-12
- feat: Added Client.ReadResponseAsString property to enable debugging. Closes #20. 2024-11-12
- feat: Added PropertyData.Example. 2024-11-07
🐞 Last 10 bug fixes:
- fix: Added missing UnixTimestampJsonConverter in JsonSettings. 2024-11-18
- fix(cli): Fixed warning for IsAotCompatible. 2024-11-14
- fix: Fixed issue with incorrect ByteArray/String responses in release mode. 2024-11-13
- fix(cli): Now draft PRs will not trigger PR test pipeline. 2024-11-13
- fix(cli): Fixed mkdocs github actions template. 2024-11-13
- fix: Try to use response with schema for Success response if it there. 2024-11-13
- fix: Fixed xml doc for <defaul> tag. 2024-11-12
- fix: Fixed missing xml param doc for required deprecated properties. 2024-11-12
- fix: Now error responses have order. 2024-11-12
- fix: Use ApiException instead System.InvalidOperationException in methods. 2024-11-12