Reo.Core.ApiDocumentation 10.0.33

.NET 10.0

dotnet add package Reo.Core.ApiDocumentation --version 10.0.33

NuGet\Install-Package Reo.Core.ApiDocumentation -Version 10.0.33

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="Reo.Core.ApiDocumentation" Version="10.0.33" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Reo.Core.ApiDocumentation" Version="10.0.33" />
                    

                            Directory.Packages.props

<PackageReference Include="Reo.Core.ApiDocumentation" />
                    

                            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 Reo.Core.ApiDocumentation --version 10.0.33

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Reo.Core.ApiDocumentation, 10.0.33"

#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 Reo.Core.ApiDocumentation@10.0.33

#: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=Reo.Core.ApiDocumentation&version=10.0.33
                    

                            Install as a Cake Addin

#tool nuget:?package=Reo.Core.ApiDocumentation&version=10.0.33
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Reo.Core.ApiDocumentation

Описание пакета

Пакет Reo.Core.ApiDocumentation предназначен для интеграции Swagger (OpenAPI) с IdentityServer в ASP.NET Core-приложениях. Он решает проблему автоматической настройки Swagger-документации с поддержкой OAuth2-авторизации, используя конфигурации клиентов из IdentityServer.

Основные функции:

Автоматическое получение информации о клиенте (ClientId, AllowedScopes) из IdentityServer.
Настройка Swagger-документации с поддержкой OAuth2.
Поддержка кастомных фильтров и операций для Swagger.

Основные компоненты

1. `ClientDefinition`

Описание: Класс, содержащий метаданные о клиенте (ClientId, ClientName, AllowedScopes, TokenEndpoint и т.д.).
Использование: Используется для передачи информации о клиенте в Swagger-конфигурацию.

2. `IdentityClientSwaggerDefinitionStrategy`

Описание: Стратегия для получения определения клиента из IdentityServer через API-запрос.
Использование: Используется для динамической загрузки конфигурации клиента из IdentityServer.

3. `DefaultConfigureSwaggerOptions`

Описание: Класс для настройки SwaggerGen с использованием информации о клиенте.
Использование: Регистрируется как IConfigureOptions<SwaggerGenOptions> для автоматической настройки Swagger.

4. `DefaultPathDocumentFilter`

Описание: Фильтр для документа Swagger, удаляющий серверы по умолчанию.
Использование: Применяется для кастомизации вывода Swagger-документации.

Требования

.NET: .NET Core 3.1, .NET 5+, .NET 6+.
Зависимости:
- Swashbuckle.AspNetCore (для генерации Swagger).
- IdentityModel.Client (для работы с IdentityServer).

Установка

NuGet Package Manager

Install-Package Reo.Core.ApiDocumentation -Version 1.0.0

.NET CLI

dotnet add package Reo.Core.ApiDocumentation --version 1.0.0

Настройка

Регистрация в ASP.NET Core

Добавьте в Startup.cs или Program.cs (для .NET 6+):

public void ConfigureServices(IServiceCollection services)
{
    services.AddSwaggerGen(options =>
    {
        options.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
        options.UseDefaultConfiguration();
    });

    services.Configure<AuthConfigureOptions>(Configuration.GetSection("Auth"));
}

Конфигурационные параметры

Добавьте в appsettings.json:

{
  "Auth": {
    "IdentityServerUrl": "https://identityserver.example.com",
    "ClientId": "my-client-id"
  }
}

Использование

Пример 1: Настройка Swagger с OAuth2

public void ConfigureServices(IServiceCollection services)
{
    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
        c.UseDefaultConfiguration(); // Использует конфигурацию из IdentityServer
        c.AddSecurityDefinition("oauth2", new OpenApiSecurityScheme
        {
            Type = SecuritySchemeType.OAuth2,
            Flows = new OpenApiOAuthFlows
            {
                Implicit = new OpenApiOAuthFlow
                {
                    AuthorizationUrl = new Uri("https://identityserver.example.com/connect/authorize"),
                    TokenUrl = new Uri("https://identityserver.example.com/connect/token")
                }
            }
        });
    });
}

Пример 2: Кастомизация Swagger UI

app.UseSwaggerUI(options =>
{
    options.OAuthClientId("my-client-id");
    options.OAuthClientSecret("my-client-secret");
    options.OAuthAppName("My Application");
});

Лицензия

Данный пакет распространяется под лицензией MIT.

Product	Compatible and additional computed target framework versions.
.NET	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.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net10.0
- Asp.Versioning.Mvc (>= 8.1.1)
- Asp.Versioning.Mvc.ApiExplorer (>= 8.1.1)
- FluentValidation (>= 12.1.1)
- FluentValidation.AspNetCore (>= 11.3.1)
- Flurl (>= 4.0.0)
- Flurl.Http (>= 4.0.2)
- Flurl.Http.Newtonsoft (>= 0.9.1)
- IdentityModel (>= 7.0.0)
- JetBrains.Annotations (>= 2025.2.4)
- Microsoft.AspNetCore.Authentication.JwtBearer (>= 10.0.3)
- Microsoft.AspNetCore.Authentication.OpenIdConnect (>= 10.0.3)
- Microsoft.AspNetCore.Mvc.NewtonsoftJson (>= 10.0.3)
- Microsoft.Extensions.Configuration (>= 10.0.3)
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.3)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.3)
- Microsoft.Extensions.DependencyInjection (>= 10.0.3)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.3)
- Microsoft.Extensions.Hosting.Abstractions (>= 10.0.3)
- Microsoft.Extensions.Http.Polly (>= 10.0.3)
- Microsoft.Extensions.Logging (>= 10.0.3)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.3)
- Microsoft.Extensions.Options (>= 10.0.3)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 10.0.3)
- Newtonsoft.Json (>= 13.0.4)
- Polly (>= 8.5.0)
- Reo.Core.Auth (>= 10.0.33)
- Reo.Core.Validation (>= 10.0.33)
- stbychkov.AutoLoggerMessage (>= 1.0.15)
- Swashbuckle.AspNetCore (>= 10.1.2)
- System.Linq.Async (>= 7.0.0)

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
10.0.33	0	2/13/2026
10.0.32	0	2/13/2026
10.0.31	11	2/13/2026
10.0.30	34	2/12/2026
10.0.29	39	2/12/2026
10.0.28	72	2/11/2026
10.0.27	71	2/11/2026
10.0.26	83	2/9/2026
10.0.25	77	2/9/2026
10.0.24	82	2/9/2026
10.0.23	76	2/9/2026
10.0.22	77	2/9/2026
10.0.21	79	2/9/2026
10.0.20	80	2/9/2026
10.0.15	83	2/6/2026
10.0.14	78	2/6/2026
10.0.13	82	2/4/2026
10.0.12	83	2/3/2026
10.0.11	90	2/2/2026
10.0.10	85	1/29/2026