Ctyar.NSwag.Yarp 0.1.0

.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. 
dotnet add package Ctyar.NSwag.Yarp --version 0.1.0                

                    
                

            
NuGet\Install-Package Ctyar.NSwag.Yarp -Version 0.1.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="Ctyar.NSwag.Yarp" Version="0.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Ctyar.NSwag.Yarp --version 0.1.0                

                    
                

            
#r "nuget: Ctyar.NSwag.Yarp, 0.1.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. 
// Install Ctyar.NSwag.Yarp as a Cake Addin
#addin nuget:?package=Ctyar.NSwag.Yarp&version=0.1.0

// Install Ctyar.NSwag.Yarp as a Cake Tool
#tool nuget:?package=Ctyar.NSwag.Yarp&version=0.1.0

NSwag Yarp

Build Status Ctyar.NSwag.Yarp

A package to simplify using NSwag behind YARP.

Usage

  1. Add a route for each of your APIs like this:

    "route1": {
 "ClusterId": "cluster1",
 "Match": {
   "Path": "/api1/{**catch-all}"
 },
 "Transforms": [
   {
     "PathRemovePrefix": "/api1"
   }
 ]
}

    With this configuration, calling /api1 of your YARP will redirect to your RESTful API.

  2. Add AddYarp() with the same prefix in your RESTful API:

    app.UseOpenApi(config =>
{
    config.AddYarp("/api1");
});

app.UseSwaggerUi(config =>
{
    config.AddYarp("/api1");
});

You can check the samples directory for a complete working example.

Build

Install the required .NET SDK.

Run:

$ dotnet build
Product 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. 
.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.

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.1.0 667 4/20/2024