寻求可自动生成.NET程序集公共API文本文件的工具
适合的工具推荐
ApiPort(微软官方出品)
- 可直接作为构建后步骤集成,生成的公共API清单能导出为纯文本格式,默认按命名空间、类型、成员的字母顺序排列,完全满足每行一个元素的要求。
- 配置时只需在构建后脚本中调用
ApiPort.exe,指定目标程序集和输出路径为src/PublicAPIs.txt,每次构建完成后自动更新文件。 - 提交到Git后,GitHub Diff能直接展示API的增删改,日常工作流里一眼就能发现是否存在破坏性变更或意外暴露的私有API。
PublicApiGenerator
- 这是一款.NET库,集成到项目构建流程十分便捷,编写简单的MSBuild任务或控制台程序,就能生成符合要求的纯文本API清单。
- 生成内容会自动按字母排序,每个命名空间、类、方法等元素单独占一行,完美匹配你的需求。
- 可在
Directory.Build.props或项目.csproj文件中配置构建后执行逻辑,自动更新src/PublicAPIs.txt,无需手动操作。
DocFx(借助其API提取功能)
- 它主打文档生成,但自带的API提取模块能导出纯文本格式的公共API表面,支持按字母排序,每个元素单独占一行。
- 将DocFx的构建脚本加入项目构建后步骤,指定输出文件到Git仓库的目标路径,即可实现自动更新。
这些工具都能自动将API清单写入Git仓库,无需手动打开工具,日常构建就能同步更新文件,通过Git Diff随时监控API变化,有效降低意外破坏API的概率。
内容的提问来源于stack exchange,提问作者Lilith River
相关产品推荐
相关产品推荐

