Regira.Web.Swagger
6.5.0
dotnet add package Regira.Web.Swagger --version 6.5.0
NuGet\Install-Package Regira.Web.Swagger -Version 6.5.0
<PackageReference Include="Regira.Web.Swagger" Version="6.5.0" />
<PackageVersion Include="Regira.Web.Swagger" Version="6.5.0" />
<PackageReference Include="Regira.Web.Swagger" />
paket add Regira.Web.Swagger --version 6.5.0
#r "nuget: Regira.Web.Swagger, 6.5.0"
#:package Regira.Web.Swagger@6.5.0
#addin nuget:?package=Regira.Web.Swagger&version=6.5.0
#tool nuget:?package=Regira.Web.Swagger&version=6.5.0
Regira.Web.Swagger
Swagger UI authentication inputs for APIs documented with Swashbuckle.AspNetCore, part of Regira Web. AddJwtAuthentication() and AddApiKeyAuthentication() extend SwaggerGenOptions with a JWT Bearer or API key security definition and a document-wide security requirement, so the Swagger UI prompts for a token or key. DisplayEnumAsString() on the MVC builder adds a JsonStringEnumConverter to the controllers' JSON options, so enums are serialized, and shown in Swagger, as strings.
Installation
<PackageReference Include="Regira.Web.Swagger" Version="6.*" />
The package uses only Microsoft.OpenApi 2.x APIs. On net10.0 it references Microsoft.OpenApi 2.12.2 directly, the same version as Regira.Security.Authentication.Web, so an app referencing both resolves one version.
Documentation
- Web.Swagger — registering the JWT and API key inputs, and enums as strings
- OpenAPI document transformers — security schemes and per-operation requirements for the built-in
AddOpenApidocument (.NET 10), inRegira.Security.Authentication.Web
License
Apache License 2.0 — this package contains no license validation and no runtime limits. See LICENSE. A few companion packages are commercially licensed with a free tier; see the licensing overview.
| Product | Versions 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 is compatible. 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. |
-
net10.0
- Microsoft.OpenApi (>= 2.12.2)
- Regira.Web (>= 6.5.0)
- Swashbuckle.AspNetCore (>= 10.2.3)
-
net8.0
- Regira.Web (>= 6.5.0)
- Swashbuckle.AspNetCore (>= 10.2.3)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.