MiniController.Attributes
1.0.1
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package MiniController.Attributes --version 1.0.1
NuGet\Install-Package MiniController.Attributes -Version 1.0.1
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="MiniController.Attributes" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="MiniController.Attributes" Version="1.0.1" />
<PackageReference Include="MiniController.Attributes" />
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 MiniController.Attributes --version 1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: MiniController.Attributes, 1.0.1"
#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 MiniController.Attributes@1.0.1
#: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=MiniController.Attributes&version=1.0.1
#tool nuget:?package=MiniController.Attributes&version=1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
MiniController
MiniController 是一个基于 Roslyn Source Generator 的 Standard 2.0 端点自动注册工具。它通过自定义特性(如 MiniControllerAttribute
)自动生成分组端点注册扩展方法,简化 API 路由、授权、过滤器和响应类型的声明与维护。
特性
- 自动识别带有
MiniControllerAttribute
的类,生成分组路由注册代码。 - 支持分组和方法级别的授权(
AuthorizeAttribute
、AllowAnonymousAttribute
)。 - 支持分组和方法级别的 API Explorer 设置(
ApiExplorerSettingsAttribute
)。 - 支持响应类型声明(
ProducesResponseTypeAttribute
)。 - 支持端点过滤器(
FilterType
)。 - 自动生成
MapMiniController
扩展方法,一键注册所有 MiniController。
快速开始
安装依赖
项目依赖于.NET Standard 2.0,确保你的项目环境满足要求。
定义 MiniController
[MiniController("/api/demo", Name = "DemoGroup")]
public static class DemoController
{
[HttpGet("hello")]
[ProducesResponseType(typeof(string), 200)]
public static IResult Hello() => Results.Ok("Hello World");
}
- 自动生成扩展方法
编译后,Source Generator 会自动生成如下扩展方法:
DemoControllerExtensions.MapDemoController
MiniControllerExtensions.MapMiniController
- 在应用启动时注册所有端点
app.MapMiniController();
主要依赖
Microsoft.CodeAnalysis
Microsoft.AspNetCore.Builder
Microsoft.AspNetCore.Http
进阶用法
- 支持分组和方法级别的授权、过滤器、API Explorer 设置。
- 支持多种 HTTP 方法(GET、POST、PUT、DELETE、PATCH、HEAD、OPTIONS)。
- 支持自定义响应类型和内容类型。
贡献与反馈
如有建议或问题,欢迎提交 Issue 或 PR。
自动生成声明 本项目部分代码由 Source Generator 自动生成,请勿手动修改生成文件。
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. 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. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.