Senparc.Xncf.Swagger
0.20.6
Prefix Reserved
dotnet add package Senparc.Xncf.Swagger --version 0.20.6
NuGet\Install-Package Senparc.Xncf.Swagger -Version 0.20.6
<PackageReference Include="Senparc.Xncf.Swagger" Version="0.20.6" />
<PackageVersion Include="Senparc.Xncf.Swagger" Version="0.20.6" />
<PackageReference Include="Senparc.Xncf.Swagger" />
paket add Senparc.Xncf.Swagger --version 0.20.6
#r "nuget: Senparc.Xncf.Swagger, 0.20.6"
#:package Senparc.Xncf.Swagger@0.20.6
#addin nuget:?package=Senparc.Xncf.Swagger&version=0.20.6
#tool nuget:?package=Senparc.Xncf.Swagger&version=0.20.6
Senparc.Xncf.Swagger
Senparc.Xncf.Swagger integrates Swagger/OpenAPI document generation with an NCF ASP.NET Core application.
Features
- Adds an XNCF module boundary for API documentation configuration.
- Discovers MVC controller actions and their HTTP method, API-version, and route metadata.
- Uses generated XML documentation when the host enables XML documentation output.
- Provides a consistent place for NCF applications to extend document filters and API descriptions.
Installation
<PackageReference Include="Senparc.Xncf.Swagger" Version="0.26.0-preview3" />
Key API and requirements
- Mark actions with
[HttpGet],[HttpPost], or another HTTP method attribute. - Add API-version metadata such as
[ApiVersion("1")]where versioning is enabled. - Add an explicit
[Route("...")]so the generated document has a stable path. - Enable XML documentation generation in the consuming project for method and model comments.
The current integration targets MVC API actions. Razor Pages are not automatically described as API operations. Protect the Swagger endpoint and avoid publishing secrets, internal routes, or unrestricted schemas in production.
| Product | Versions 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. |
-
net10.0
- Microsoft.AspNetCore.Mvc.Versioning (>= 5.1.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.6)
- Microsoft.Extensions.FileProviders.Embedded (>= 10.0.2)
- Senparc.CO2NET.WebApi (>= 2.1.9-preview)
- Senparc.Ncf.AreaBase (>= 0.23.6)
- Senparc.Xncf.AreasBase (>= 0.13.8)
- Swashbuckle.AspNetCore.Annotations (>= 10.1.0)
- Swashbuckle.AspNetCore.SwaggerGen (>= 10.1.0)
- Swashbuckle.AspNetCore.SwaggerUI (>= 10.1.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 |
|---|---|---|
| 0.20.6 | 92 | 8/29/2026 |
| 0.20.5 | 98 | 8/23/2026 |
| 0.20.4-preview8 | 94 | 8/14/2026 |
| 0.20.3-preview7 | 89 | 8/12/2026 |
| 0.20.2-preview6 | 88 | 8/8/2026 |
| 0.20.1-preview5 | 98 | 8/3/2026 |
| 0.20.0-preview4 | 94 | 7/31/2026 |
| 0.19.1-preview3 | 60 | 7/28/2026 |
| 0.19.0-preview2 | 64 | 7/26/2026 |
| 0.18.1-preview1 | 78 | 6/17/2026 |
| 0.17.2.1-preview | 76 | 5/9/2026 |
| 0.17.2-preview | 74 | 6/16/2026 |
| 0.17.1-preview.1 | 100 | 2/13/2026 |
| 0.17.0.4-preview | 103 | 12/28/2025 |
| 0.17.0.2-preview | 125 | 12/28/2025 |
| 0.17.0-preview.1 | 190 | 9/27/2025 |
| 0.16.12.6-preview1 | 245 | 8/20/2025 |
| 0.16.12.4-preview1 | 217 | 8/18/2025 |
| 0.16.12.3-preview1 | 251 | 7/14/2025 |
| 0.16.12.2-preview1 | 229 | 7/2/2025 |
v0.1.0 创世
v0.6.6 添加 Enable 开关选项
v0.11.0 加载默认的 appsettings.json
[2024-09-10] v0.14.4-preview1 升级缓存基础库
[2024-10-09] v0.14.6-preview1 升级基础库
[2024-10-09] v0.14.7-preview1 升级基础库
[2024-10-16] v0.14.8-preview1 添加 Service 对 PagedList 对象快速 Mapping 到 DTO 对象的方法
[2024-11-08] v0.14.11-preview1 升级 Senparc.AI
[2024-11-08] v0.14.12-preview1 升级 Senparc.AI
[2024-11-15] v0.15.0-preview1 使用新版本 AutoGen,升级 AgentsManager;解决 AgentsManager 中状态获取的异常
[2024-11-21] v0.16.2-preview1 更新 CO2NET 及缓存基础库
[2024-11-28] v0.16.3-preview1 update CO2NET, use new SenparcSetting with UseLowerCaseApiName property
[2024-12-04] v0.16.4-preview1 update Swagger Xncf module, fix UseLowerCaseApiName not applied
[2025-01-25] v0.16.8-preview1 Update Agents functions, support for function calling
[2025-04-29] v0.16.10-preview1 Update CO2NET and AIKernel
[2025-05-18] v0.16.11-preview1 Update Installation
[2025-06-20] v0.16.12-preview1 Add MCP functions in XncfRegisterBase class
[2025-09-27] v0.17.0-preview.1 Add default sort for Swagger version(module name)
[2025-11-01] update basic libraries, including Senparc.AI
[2026-07-17] v0.19.0-preview2 为 Swagger 模块接入统一资源本地化并优化功能文案
1、接入统一资源本地化机制,支持模块功能文案按当前文化动态显示
2、统一模块注册信息、菜单名称与功能描述的本地化输出
3、补充并统一多语言资源键及资源文件
[2026-07-29] v0.19.1-preview3 修正 Swagger 认证中间件的认证方案处理
1、按 Admin 和 JWT 认证方案执行认证并将成功主体写回请求上下文
2、未通过认证时继续跳转登录页,避免仅依赖请求头字符串判断
[2026-07-31] v0.20.0-preview4 扩展 Swagger 管理交互的多语言能力
1、将 Swagger 前端交互提示接入本地化资源
2、升级 Senparc.CO2NET.WebApi 至 2.1.9-preview
[2026-08-04] v0.20.1-preview5 Dependency updates from upstream projects
1、Dependency update from Senparc.Ncf.AreaBase to 0.23.1-preview5
2、Dependency update from Senparc.Xncf.AreasBase to 0.13.3-preview5
[2026-08-08] v0.20.2-preview6 Dependency updates from upstream projects
1、Dependency update from Senparc.Ncf.AreaBase to 0.23.2-preview6
2、Dependency update from Senparc.Xncf.AreasBase to 0.13.4-preview6
[2026-08-13] v0.20.3-preview7 Dependency update from Senparc.Ncf.AreaBase to 0.23.3-preview7
[2026-08-15] v0.20.4-preview8 Dependency update from Senparc.Ncf.AreaBase to 0.23.4-preview8; [5955]Senparc.Xncf.AreasBase to 0.13.6-preview8
[2026-08-22] v0.20.5-preview9 同步 Senparc.Xncf.Swagger 依赖版本
1、递归更新上游项目依赖,保持 Senparc.Xncf.Swagger 与当前版本组合兼容
[2026-08-29] v0.20.6 Dependency updates from Senparc.Ncf.AreaBase to 0.23.6; Dependency update from [5955]Senparc.Xncf.AreasBase to 0.13.8
1、Dependency update from Senparc.Ncf.AreaBase to 0.23.6
2、Dependency update from [5955]Senparc.Xncf.AreasBase to 0.13.8