XiHan.Framework.Kernel.Generators 5.0.0-preview.2

Prefix Reserved
This is a prerelease version of XiHan.Framework.Kernel.Generators.
dotnet add package XiHan.Framework.Kernel.Generators --version 5.0.0-preview.2
                    
NuGet\Install-Package XiHan.Framework.Kernel.Generators -Version 5.0.0-preview.2
                    
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="XiHan.Framework.Kernel.Generators" Version="5.0.0-preview.2">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="XiHan.Framework.Kernel.Generators" Version="5.0.0-preview.2" />
                    
Directory.Packages.props
<PackageReference Include="XiHan.Framework.Kernel.Generators">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
                    
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 XiHan.Framework.Kernel.Generators --version 5.0.0-preview.2
                    
#r "nuget: XiHan.Framework.Kernel.Generators, 5.0.0-preview.2"
                    
#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 XiHan.Framework.Kernel.Generators@5.0.0-preview.2
                    
#: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=XiHan.Framework.Kernel.Generators&version=5.0.0-preview.2&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=XiHan.Framework.Kernel.Generators&version=5.0.0-preview.2&prerelease
                    
Install as a Cake Tool

XiHan.Framework.Kernel.Generators

关于

XiHan.Framework.Kernel.Generators 是 Roslyn 源生成器:扫描标注 [Operation] 且实现 IOperation<TRequest, TResponse> 的类,在编译期生成操作登记代码与每个操作的请求、响应 JSON Schema,不需要运行期反射。

主要特性

  • 生成 GeneratedOperations:每个操作一个 Add<类名>,以及登记全部操作的 AddGeneratedOperations
  • 生成 JSON Schema(draft 2020-12),供 HTTP 的 OpenAPI、MCP 的 tool 描述与内核的契约校验使用
  • [Required]、[Range]、[StringLength]、XML 文档注释折进 Schema
  • XHG001–XHG006 诊断:缺接口、缺序列化登记、操作 ID 文法等

如何使用

安装

dotnet add package XiHan.Framework.Kernel.Generators --prerelease

使用

项目里用 [JsonSerializable] 登记请求与响应类型,在特性的 Configure 里调用生成的登记方法:

[Operation("orders.create", Expose = Expose.Http | Expose.Mcp, Permission = "orders.write")]
public sealed class CreateOrder(...) : IOperation<PlaceOrderRequest, OrderResponse> { ... }

public void Configure(FeatureContext context) => context.AddGeneratedOperations();

用 NuGet 包时按分析器引用,不进入运行时依赖。程序集级 [assembly: OperationDefaults(Expose = Expose.Http)] 设置没写 Expose 的操作的缺省暴露协议。

主要类型

此库提供的主要类型:

  • OperationAttribute:声明操作的 ID、稳定性、暴露协议与权限
  • OperationDefaultsAttribute:程序集级的暴露协议缺省
  • GeneratedOperations(生成):AddGeneratedOperations(this FeatureContext)

更多文档

相关包

反馈与贡献

XiHan.Framework.Kernel.Generators 以 MIT 许可证 开源。欢迎到 GitHub 仓库 提交问题和贡献。

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

This package has 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.

Version Downloads Last Updated
5.0.0-preview.2 0 11/6/2026
5.0.0-preview.1 44 11/4/2026