AArkhipenko.Swagger
7.0.0
dotnet add package AArkhipenko.Swagger --version 7.0.0
NuGet\Install-Package AArkhipenko.Swagger -Version 7.0.0
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="AArkhipenko.Swagger" Version="7.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="AArkhipenko.Swagger" Version="7.0.0" />
<PackageReference Include="AArkhipenko.Swagger" />
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 AArkhipenko.Swagger --version 7.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: AArkhipenko.Swagger, 7.0.0"
#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 AArkhipenko.Swagger@7.0.0
#: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=AArkhipenko.Swagger&version=7.0.0
#tool nuget:?package=AArkhipenko.Swagger&version=7.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
AArkhipenko.Swagger
Nuget-проект с настройками для работы с Swagger
Настройки
Требуется указание:
- SERVICE_NAME в переменных окружения (если значение совпадает с названием исполняемого проекта, тогда включается описанеи АПИ при помощи XML-документа)
Методы расширения
Все методы расширения находятся здесь
Работа со Swagger
Для настройки работы Swagger доступны методы:
- По списку версий (строки)
- По списку версий (OpenApiInfo)
- По списку версий (строки) + настройки авторизации
- По списку версий (OpenApiInfo) + настройки авторизации
Для использования Swagger доступны методы:
- С указанием списка версий (строки)
- С указанием списка версий (OpenApiInfo)
Подключение:
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddControllers();
var versions = new[]
{
$"v10",
$"v11"
};
var security = new[]
{
new SecurityModel("BearerAuth", new OpenApiSecurityScheme
{
Name = "Authorization",
Type = SecuritySchemeType.Http,
Scheme = JwtBearerDefaults.AuthenticationScheme,
BearerFormat = "JWT",
In = ParameterLocation.Header,
Description = "JWT Authorization header \"Authorization: Bearer {token}\"",
Reference = new OpenApiReference
{
Type = ReferenceType.SecurityScheme,
Id = "BearerAuth"
}
})
};
// Добавление работы с Swagger
builder.Services.AddCustomSwagger(versions, security);
...
var app = builder.Build();
// Использование middleware Swagger
app.UseCustomSwagger(versions);
...
app.MapControllers();
app.Run();
Для описания АПИ можно использовать:
- Аттрибуты аннотации (требуется подключение nuget-пакета Swashbuckle.AspNetCore.Annotations)
- XML-документ (требуется включение XML-файл документации в найстройках проекта без указания пути)
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. 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.
-
net7.0
- AArkhipenko.Core (>= 7.0.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
- Swashbuckle.AspNetCore.Annotations (>= 7.3.2)
- Swashbuckle.AspNetCore.SwaggerGen (>= 7.3.2)
- Swashbuckle.AspNetCore.SwaggerUI (>= 7.3.2)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.