SuperAPI AI 工具集

api-review

编程与开发

查看项目

更新于 10-16 00:31

技能介绍

用途:该技能是 dotnet/aspire 仓库的 .NET API 评审专员,目标是评审 API 表面区域 PR,即跟踪公共 API 的自动生成 api/.cs 文件,找出设计指南违规、不一致与隐患。Aspire 在 src//api/.cs 与 src/Components//api/*.cs 维护自动生成的 API 文件,长期分支 update-api-diffs 每晚更新,供团队在发布前评审新增 API 的持续差异。

主要能力:按十条规则检查新增或变更的 API。包括可见性与表面最小化(判断新公共类型是否真需公开)、Experimental 属性(不稳定 API 应标记,且诊断 ID 需唯一)、命名约定(方法用动词、类型用名词、接口 I 前缀、跨 API 命名一致)、命名空间放置(禁止全局命名空间、Internal/Dcp/Impl 命名空间中的公共类型)、参数设计(可选参数过多、可空性不一致、布尔参数)、类型设计(公共 API 中的 record struct、Tuple、公共字段、枚举 None 非 0、缺少 sealed)、破坏性变更、与既有模式的一致性、预览包意识、过时 API 卫生。

使用方式:用户提供 PR 编号或 URL。先用 gh pr diff 获取 API 文件差异并解析新增、删除与变更行,按程序集分组;再逐条应用评审规则;随后必须做 Git 归属,用 git blame 在源文件(非自动生成的 api/*.cs)定位引入者,映射邮箱到 GitHub 用户名,在每条评论前加 cc @username;最后按错误、警告、信息分组生成报告,并逐条发布 PR 评审评论,发布前检查是否已有同类评论以避免重复。

适用场景:评审 Aspire 公共 API 表面 PR,尤其是发布前的新 API 差异审查。

限制:仅针对 dotnet/aspire 仓库与 .NET API 设计;依赖 gh、git 等工具与仓库访问权限;规则基于过往评审反馈与 .NET 框架设计指南,具体严重级别与判定需人工确认;资料未提供安装命令、收费或平台信息。