Getting NSwag to work behind reverse proxy

PublishedDecember 18, 2020

•2 min read•View as Markdown

Getting NSwag to work behind reverse proxy

Søren Kruse

Comments

Join the discussion

No comments yet. Be the first to comment.

More from this blog

Dynamic caching policy with Polly

Polly is great library for easily configuring different kinds of policies around code execution, be it retry, circuit breaker, caching or lots of other things. It's probably most often used around HTTP requests. If you haven't heard about it you defi...

Jan 15, 20213 min read

Unit Testing - Part 2: Naming, structure and readability

This is part 2 of my series on unit testing in .NET (C#) and will be about my conventions regarding naming unit tests, how to structure them and which parts to test. And lastly I will help you increase readability of assertions and potential error me...

Jan 9, 20217 min read

Unit Testing - Part 2: Naming, structure and readability

Unit Testing - Part 1: Getting started with unit tests in .NET

I feel like unit testing is very important and very beneficial in a lot of ways. It helps with not breaking existing functionality and thereby also making you more confident in changing code without fear of breaking important stuff. Often it also mak...

Dec 28, 20207 min read

Unit Testing - Part 1: Getting started with unit tests in .NET

NSubstitute - make async method (Task) throw an exception

The other day I was writing a unit test to verify what was supposed to happen when a Task would throw an exception when awaited. It wasn't as straight forward as I first assumed, but I quickly found this Stack Overflow post that helped me: https://st...

Dec 12, 20203 min read

NSubstitute - make async method (Task) throw an exception

Søren Kruse | .NET, C# and Azure

51 posts

public class Startup { // ... public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { // ... app.UseXForwardedHeaders(); app.UseSwaggerWithReverseProxySupport(); } } static class StartupExtensions { public static IApplicationBuilder UseXForwardedHeaders(this IApplicationBuilder app) { var options = new ForwardedHeadersOptions { ForwardedHeaders = ForwardedHeaders.XForwardedFor | ForwardedHeaders.XForwardedProto }; // Only loopback proxies are allowed by default. // Clear that restriction because forwarders are being enabled by explicit configuration. // https://stackoverflow.com/a/56469499/5358985 options.KnownNetworks.Clear(); options.KnownProxies.Clear(); app.UseForwardedHeaders(options); app.Use((context, next) => { if (context.Request.Headers.TryGetValue("X-Forwarded-PathBase", out var pathBases)) { context.Request.PathBase = pathBases.First(); } return next(); }); return app; } public static IApplicationBuilder UseSwaggerWithReverseProxySupport(this IApplicationBuilder app) { app.UseOpenApi(config => { // Without this the document will be cached with wrong URLs // and not work if later accessed from another host/path/scheme config.CreateDocumentCacheKey = request => request.Headers["X-Forwarded-Host"].FirstOrDefault() + request.Headers["X-Forwarded-PathBase"].FirstOrDefault() + request.IsHttps; // Change document host and base path from headers (if set) config.PostProcess = (document, request) => { document.BasePath = request.Headers["X-Forwarded-PathBase"].FirstOrDefault(); document.Host = request.Headers["X-Forwarded-Host"].FirstOrDefault(); }; }); app.UseSwaggerUi3(settings => { settings.TransformToExternalPath = (route, request) => { var pathBase = request.Headers["X-Forwarded-PathBase"].FirstOrDefault(); return !string.IsNullOrEmpty(pathBase) ? $"{pathBase}{route}" : route; }; }); return app; } }

Command Palette

Comments

More from this blog