Treyt.Yarp.ReverseProxy.Swagger 3.0.1

👁 dotnet_main
👁 release
👁 nuget
👁 nuget_downloads

Introduction

It's an easy to use Swagger extension for the YARP project.

Getting Started

Configure Swagger and YARP for your project.

Update appsettings.json:

{
 "ReverseProxy": {
 "Clusters": {
 "App1Cluster": {
 "Destinations": {
 "Default": {
 "Address": "https://localhost:5101",
 "Swaggers": [ // <-- this block
 {
 "PrefixPath": "/proxy-app1",
 "Paths": [
 "/swagger/v1/swagger.json"
 ]
 }
 ]
 }
 }
 }
 }
 }
}

Create (if doesn't exist) or update :

public void Configure(SwaggerGenOptions options)
{
 var filterDescriptors = new List<FilterDescriptor>();

 foreach (var cluster in _reverseProxyDocumentFilterConfig.Clusters)
 {
 options.SwaggerDoc(cluster.Key, new OpenApiInfo {Title = cluster.Key, Version = cluster.Key});
 }

 filterDescriptors.Add(new FilterDescriptor
 {
 Type = typeof(ReverseProxyDocumentFilter),
 Arguments = Array.Empty<object>()
 });

 options.DocumentFilterDescriptors = filterDescriptors;
}

Update Program.cs:

builder.Services.AddTransient<IConfigureOptions<SwaggerGenOptions>, ConfigureSwaggerOptions>();
builder.Services.AddSwaggerGen();

var configuration = builder.Configuration.GetSection("ReverseProxy");
builder.Services
 .AddReverseProxy()
 .LoadFromConfig(configuration)
 .AddSwagger(configuration); // <-- this line

app.UseSwaggerUI(options =>
{
 var config = app.Services.GetRequiredService<IOptionsMonitor<ReverseProxyDocumentFilterConfig>>().CurrentValue;
 foreach (var cluster in config.Clusters)
 {
 options.SwaggerEndpoint($"/swagger/{cluster.Key}/swagger.json", cluster.Key);
 }
});

After run you will get generated Swagger files by clusters:

👁 image

Authentication and Authorization

Update appsettings.json:

{
 "ReverseProxy": {
 "Clusters": {
 "App1Cluster": {
 "Destinations": {
 "Default": {
 "Address": "https://localhost:5101",
 "AccessTokenClientName": "Identity", // <-- this line
 "Swaggers": [
 {
 "PrefixPath": "/proxy-app1",
 "Paths": [
 "/swagger/v1/swagger.json"
 ]
 }
 ]
 }
 }
 }
 }
 }
}

Update Program.cs:

builder.Services.AddAccessTokenManagement(options =>
{
 var identityConfig = builder.Configuration.GetSection("Identity").Get<IdentityConfig>()!;
 
 options.Client.Clients.Add("Identity", new ClientCredentialsTokenRequest
 {
 Address = $"{identityConfig.Url}/connect/token",
 ClientId = identityConfig.ClientId,
 ClientSecret = identityConfig.ClientSecret
 });
});