Oproto.Lambda.OpenApi.Merge
1.2.0
dotnet add package Oproto.Lambda.OpenApi.Merge --version 1.2.0
NuGet\Install-Package Oproto.Lambda.OpenApi.Merge -Version 1.2.0
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="Oproto.Lambda.OpenApi.Merge" Version="1.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Oproto.Lambda.OpenApi.Merge" Version="1.2.0" />
<PackageReference Include="Oproto.Lambda.OpenApi.Merge" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Oproto.Lambda.OpenApi.Merge --version 1.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Oproto.Lambda.OpenApi.Merge, 1.2.0"
#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.
#:package Oproto.Lambda.OpenApi.Merge@1.2.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Oproto.Lambda.OpenApi.Merge&version=1.2.0
#tool nuget:?package=Oproto.Lambda.OpenApi.Merge&version=1.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Oproto Lambda OpenAPI
<p align="center"> <img src="https://raw.githubusercontent.com/oproto/lambda-openapi/main/docs/assets/logo.svg" alt="Oproto Lambda OpenAPI" width="400"> </p>
A .NET source generator that automatically creates OpenAPI specifications from AWS Lambda functions decorated with Lambda Annotations.
Features
- 🚀 Source Generator: Compile-time OpenAPI spec generation
- 🏷️ Attribute-Based: Simple attribute decoration for API documentation
- 🔧 MSBuild Integration: Seamless integration with your build process
- 📝 AWS Lambda Support: Designed specifically for Lambda Annotations
- 🎯 Type-Safe: Leverages C# type system for accurate schemas
- ⚡ AOT Compatible: Works with Native AOT compilation
Requirements
- .NET 6.0 or later (compatible with .NET 6, 7, 8, 9, 10+)
- AWS Lambda Annotations package
Quick Start
- Install the package:
dotnet add package Oproto.Lambda.OpenApi
- Decorate your Lambda functions with OpenAPI attributes:
using Oproto.Lambda.OpenApi.Attributes;
[LambdaFunction]
[OpenApiOperation("GetUser", "Retrieves user information")]
[OpenApiTag("Users")]
public async Task<APIGatewayProxyResponse> GetUser(
[FromRoute] string userId,
[FromQuery] bool includeDetails = false)
{
// Your implementation
}
- Build your project - the OpenAPI spec will be generated automatically as
openapi.json
Documentation
Links
License
MIT License - see LICENSE for details.
Built with ❤️ by Oproto Inc for the .NET and AWS communities
| 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 was computed. 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 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.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 was computed. 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.
-
.NETStandard 2.0
- Microsoft.OpenApi (>= 1.6.22)
- Microsoft.OpenApi.Readers (>= 1.6.22)
- 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.