RicoSuter/NSwag

NSwag and Service Fabric

Open

#1,220 opened on Mar 13, 2018

View on GitHub
 (15 comments) (0 reactions) (0 assignees)C# (1,189 forks)batch import
help wantedtype: question

Repository metrics

Stars
 (6,291 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

I'm trying to move from Swagger/Swatchbuckle to NSwag but im running into issues trying to access swagger ui.

Since im using Service Fabric, all my apis are behind a reverse proxy. Accessing the direct url:

http://localhost:60841/8f0077aa-6088-469d-9465-449acce86123/131654410884013502/swagger/

works, but accessing the reverse url:

http://localhost:19081/MyApp/MyService/swagger/

does not. It gets redirected to the direct url

http://localhost:19081/c94a3b54-f097-4cbe-bc82-d1e70a403134/131655768288075951/swagger/index.html?url=/c94a3b54-f097-4cbe-bc82-d1e70a403134/131655768288075951/swagger/v1/swagger.json

and reports a 404.

Accessing the reverse url did work when I was using swatchbuckle but then I also had this configuration:

app.UseSwagger(c =>
{
   c.PreSerializeFilters.Add((swaggerDoc, httpReq) => swaggerDoc.BasePath = "/MyApp/MyService");
});

Does NSwag have a option to set PreSerializeFilters? Is there another option that I can use to get the ui to work behind a reverse proxy?

Contributor guide

Research direction
Investigate how to configure NSwag's Swagger UI to work behind a reverse proxy with Service Fabric. Look for an equivalent of PreSerializeFilters in NSwag or alternative configuration options.
Tech stack
csharp
Domain
backendapi
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
C#NSwagService Fabric
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50