RicoSuter/NSwag

Disable caching of swagger.json

Open

#1,151 opened on Jan 24, 2018

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

Repository metrics

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

Description

While deploying our code to a test environment, we were getting what looked like CORS issues. After digging into it more, the swagger.json file had the host value set to localhost even though we were accessing it through a DNS entry.

After playing with it some more, we determined that the swagger.json file is cached on the server and however it is accessed first is how it will be returned until the app pool recycles. In our case, after we deployed the code on the server, someone brought up the swagger UI using localhost first.

Is it possible to turn this caching off so that the Host value dynamically changes?

Contributor guide

Research direction
Investigate the caching mechanism of swagger.json in NSwag. Start by looking at the SwaggerDocumentMiddleware or similar classes to see where the swagger.json is cached. Then propose a configuration option to disable caching, perhaps through an app setting or a property on the middleware options. Consider thread safety and performance implications.
Tech stack
csharp
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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.
Clear
Prerequisites
C#.NET
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70