Skip to content

Add appsetting EnableSwaggerUI #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 6, 2024
Merged

Add appsetting EnableSwaggerUI #132

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
01a1865
Add EnableSwaggerUI
runejo Jun 5, 2024
2db2a7b
Add EnableSwaggerUI and refactor the reading of PxApiConfiguration co…
runejo Jun 5, 2024
d9929f4
Merge branch 'main' into add-appsettings-enable-swagger-ui
runejo Jun 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions PxWeb/Config/Api2/PxApiConfigurationOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ public class PxApiConfigurationOptions
public string RoutePrefix { get; set; } = String.Empty;
public List<string> OutputFormats { get; set; } = new List<string>();
public string DefaultOutputFormat { get; set; } = String.Empty;
public bool EnableSwaggerUI { get; set; } = false;

}
}
15 changes: 9 additions & 6 deletions PxWeb/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,14 +143,17 @@ public static void Main(string[] args)
// Handle CORS configuration from appsettings.json
bool corsEnbled = builder.Services.ConfigurePxCORS(builder, _logger);

// Bind the configuration to the PxApiConfigurationOptions class
var pxApiConfiguration = new PxApiConfigurationOptions();
builder.Configuration.Bind("PxApiConfiguration", pxApiConfiguration);

var app = builder.Build();
var routePrefix = builder.Configuration.GetSection("PxApiConfiguration:RoutePrefix").Value;

app.UseMiddleware<GlobalRoutePrefixMiddleware>(routePrefix);
app.UsePathBase(new PathString(routePrefix));
app.UseMiddleware<GlobalRoutePrefixMiddleware>(pxApiConfiguration.RoutePrefix);
app.UsePathBase(new PathString(pxApiConfiguration.RoutePrefix));

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
if (pxApiConfiguration.EnableSwaggerUI || app.Environment.IsDevelopment())
{
app.UseSwagger();
app.UseSwaggerUI(options =>
Expand All @@ -171,7 +174,7 @@ public static void Main(string[] args)
{
app.UseAuthorization();

app.UseWhen(context => context.Request.Path.StartsWithSegments(routePrefix + "/admin") || context.Request.Path.StartsWithSegments("/admin"), appBuilder =>
app.UseWhen(context => context.Request.Path.StartsWithSegments(pxApiConfiguration.RoutePrefix + "/admin") || context.Request.Path.StartsWithSegments("/admin"), appBuilder =>
{
appBuilder.UseAdminProtectionIpWhitelist();
appBuilder.UseAdminProtectionKey();
Expand All @@ -184,7 +187,7 @@ public static void Main(string[] args)
app.UseIpRateLimiting();
}

app.UseWhen(context => !context.Request.Path.StartsWithSegments(routePrefix + "/admin") || context.Request.Path.StartsWithSegments("/admin"), appBuilder =>
app.UseWhen(context => !context.Request.Path.StartsWithSegments(pxApiConfiguration.RoutePrefix + "/admin") || context.Request.Path.StartsWithSegments("/admin"), appBuilder =>
{
appBuilder.UseCacheMiddleware();
});
Expand Down
3 changes: 2 additions & 1 deletion PxWeb/appsettings.Release.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@
"relational_table",
"px"
],
"DefaultOutputFormat": "px"
"DefaultOutputFormat": "px",
"EnableSwaggerUI": false
},
"LuceneConfiguration": {
"IndexDirectory": "Database"
Expand Down
3 changes: 2 additions & 1 deletion PxWeb/appsettings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@
"relational_table",
"px"
],
"DefaultOutputFormat": "px"
"DefaultOutputFormat": "px",
"EnableSwaggerUI": false
},
"LuceneConfiguration": {
"IndexDirectory": "Database"
Expand Down
3 changes: 2 additions & 1 deletion PxWebApi.BigTests/AdminDatabaseController/test_appsettings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@
"relational_table",
"px"
],
"DefaultOutputFormat": "px"
"DefaultOutputFormat": "px",
"EnableSwaggerUI": false
},
"LuceneConfiguration": {
"IndexDirectory": "Database"
Expand Down
5 changes: 3 additions & 2 deletions PxWebApi.BigTests/ConfigController/test_appsettings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
}
},
"PxApiConfiguration": {
"AAAAAAA":"BBBBBBBBB",
"AAAAAAA": "BBBBBBBBB",
"Languages": [
{
"Id": "en",
Expand Down Expand Up @@ -64,7 +64,8 @@
"relational_table",
"px"
],
"DefaultOutputFormat": "px"
"DefaultOutputFormat": "px",
"EnableSwaggerUI": false
},
"LuceneConfiguration": {
"IndexDirectory": "Database"
Expand Down
5 changes: 3 additions & 2 deletions PxWebApi.BigTests/TableController/test_appsettings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
}
},
"PxApiConfiguration": {
"AAAAAAA":"BBBBBBBBB",
"AAAAAAA": "BBBBBBBBB",
"Languages": [
{
"Id": "en",
Expand Down Expand Up @@ -64,7 +64,8 @@
"relational_table",
"px"
],
"DefaultOutputFormat": "px"
"DefaultOutputFormat": "px",
"EnableSwaggerUI": false
},
"LuceneConfiguration": {
"IndexDirectory": "Database"
Expand Down