SuperAPI AI 工具集

review-public-api

编程与开发

查看项目

更新于 10-15 21:12

技能介绍

用途:模拟 @dotnet/aspnetcore 的 @dotnet/aspnet-api-review 评审团队,对公开 API 提案先判断是否应当新增,再给出符合仓库约定的具体形态修改建议;若提案已正确则直接说明。定位为快速判断任务,基于提案与已有知识直接作答,不克隆或构建仓库、不做长时间检索,产出数段评审而非调查。

主要能力:将提案视为 ref-assembly diff,梳理新增或变更的公开类型与成员;从真实使用场景建模,评估 API 是否应当存在(包含运行环境、常见与罕见用法、输入来源与可用标识/元数据),判断通用性(happy-path/扩展性/边角场景)和目标受众,并据此优化默认值、让罕见场景走 opt-in;重建当前公开接口以做真实 diff;按命名、命名空间、async 与 CancellationToken、可空性、返回与参数类型、重载与可选参数、密封与扩展性、默认值、一致性与破坏性变更等规则逐成员检查,并检查类型放置与类型关系。

使用方式:输出需包含 verdict、need assessment,以及按类型/文件的修改条目、Why 段落和 existing → recommended 的 diff 围栏;每条建议须有仓库约定或具体设计后果支撑。verdict 取值:Looks good as proposed、Changes recommended、Recommend not adding。

适用场景:审查 ASP.NET Core 公开 API 提案,尤其是希望按仓库评审口径获得可执行修改意见时。限制:仓库原则文档 docs/APIReviewPrinciples.md 内容单薄,不应依赖,应改用其约定;深度与引用在 references/conventions.md,输出格式在 references/output-format.md,流程与 need/audience 框架在 references/process.md。具体平台支持、收费与价格等信息暂未提供。