Ez4.ClientAccess.Swagger 8.0.1

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
The owner has unlisted this package. This could mean that the package is deprecated, has security vulnerabilities or shouldn't be used anymore. 
dotnet add package Ez4.ClientAccess.Swagger --version 8.0.1
                    


                    

                
NuGet\Install-Package Ez4.ClientAccess.Swagger -Version 8.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Ez4.ClientAccess.Swagger" Version="8.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Ez4.ClientAccess.Swagger" Version="8.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Ez4.ClientAccess.Swagger" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Ez4.ClientAccess.Swagger --version 8.0.1
                    


                    

                
#r "nuget: Ez4.ClientAccess.Swagger, 8.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Ez4.ClientAccess.Swagger@8.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Ez4.ClientAccess.Swagger&version=8.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Ez4.ClientAccess.Swagger&version=8.0.1
                    


                            Install as a Cake Tool

Ez4.ClientAccess.Swagger

Prunes a Swashbuckle-generated Swagger/OpenAPI document down to what the calling client is actually allowed to see: paths outside its Ez4.ClientAccess grant, tags no longer referenced by any remaining path, and components.schemas entries no longer reachable from any remaining path. Also ships a Basic Auth scheme/policy pair for gating the Swagger UI itself, independent of the host's real authentication.

Usage

using Ez4.ClientAccess.Swagger;

builder.Services.AddSwaggerGen();
builder.Services.AddClientAccessSwaggerBasicAuth(); // optional: gates Swagger UI with Basic Auth

var app = builder.Build();

app.UseSwagger(options =>
{
    options.PreSerializeFilters.Add(new ClientAccessSwaggerFilter().Apply);
});

app.UseSwaggerUI().RequireAuthorization("SwaggerBasicAuth"); // if AddClientAccessSwaggerBasicAuth() was called

Or via the SwaggerEndpointOptions extension:

app.UseSwaggerUI(options =>
{
    options.AddClientAccessSwaggerFilter();
});

An admin client id (ClientAccessOptions.AdminClientIds) bypasses path pruning and sees every path; restricted-path removal (Swagger:RestrictedPaths config) still applies to everyone, admins included.

{
  "Swagger:RestrictedPaths": ["/api/internal/debug"],
  "SwaggerBasicAuth": {
    "Users": { "admin": "changeme" }
  }
}

Requires

Ez4.ClientAccess registered in the same host (builder.AddClientPathFromJsonPolicy()) — this package reads its IClientAccessSnapshot/ClientAccessOptions to decide what to prune.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated