Published
Aug 8, 2026
2mo ago
Total Downloads
22.2K
22,175
Install
dotnet add package Senparc.Xncf.Swagger --version 0.20.2-preview6
| Product | Versions |
|---|---|
| .NET |
README
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.
Changes from Previous Version
No structural changes between v0.20.1-preview5 and v0.20.2-preview6.
Adoption Assessment
A verified publisher signal is available. Assess fit from the package's supported frameworks, license and dependency graph rather than popularity alone.
This version is marked prerelease. Validate its API and upgrade path before production use.Compatibility metadata lists 1 target framework; confirm the exact target used by your application.
Related Guides & Workflows
Learn how to evaluate, integrate, or audit this package in your .NET project.