Asp.Net Web API项目中如何列出使用类指定字段/属性的所有API？

嘿，我完全懂你的需求——已经搞定了从Swagger里揪出返回指定字段的API，但现在要找那些在业务逻辑里实际用到这个属性的API，确实有点棘手，毕竟Swagger只管API的输入输出，碰不到内部业务代码。下面分享几个我亲测有效的方案：

1. 用Roslyn做静态代码分析（最推荐） #

这是最靠谱的自动化方案，直接从代码层面扫描所有关联：

• 写一个自定义Roslyn分析器，扫描项目中所有方法（包括业务层、控制器Action），检查是否存在访问目标属性的代码（比如myInstance.TargetProperty）。
• 对找到的方法，进一步判断是不是API控制器的Action（通过检查是否带[HttpGet]/[HttpPost]等属性，或是继承自ApiController），或是被Action直接/间接调用的业务方法。
• 如果不想自己写分析器，也可以用Visual Studio的查找所有引用功能：先找到目标属性的所有引用，手动过滤掉和API无关的，再反向追踪调用这些业务方法的API Action。中小型项目用这个手动方式足够高效。

2. 基于自定义属性的元数据追踪 #

如果项目能做一些规范约束，这个方案会非常清晰：

• 给业务层中用到目标属性的方法加自定义标记属性，比如：

  [AttributeUsage(AttributeTargets.Method)]
  public class UsesPropertyAttribute : Attribute
  {
      public Type ClassType { get; }
      public string PropertyName { get; }
  
      public UsesPropertyAttribute(Type classType, string propertyName)
      {
          ClassType = classType;
          PropertyName = propertyName;
      }
  }
  

• 在业务方法上标记：[UsesProperty(typeof(Order), nameof(Order.TotalAmount))]
• 写一个小工具，通过反射扫描所有API控制器的Action，分析它们调用的业务方法是否带有这个标记，从而关联出对应的API。

3. 运行时AOP追踪（适合调试/验证） #

如果需要确认运行时实际哪些API会触发这个属性的使用，可以用AOP框架：

• 用PostSharp或者Castle DynamicProxy给目标属性的get/set方法织入切面，当属性被访问时，记录当前调用栈（或者通过HttpContext获取当前API请求路径）。
• 运行项目，模拟各种API请求，收集日志后就能得到实际触发属性使用的API列表。
• 注意：这个方法有一定性能开销，只适合测试环境，别放到生产。

4. 结合Swagger和代码映射的半自动化方案 #

既然你已经有Swagger的API定义，可以把每个API的Action和对应代码实现关联起来：

• 从Swagger里拿到每个API的operationId，对应到控制器的Action方法名。
• 用Roslyn解析该Action的方法体，追踪它调用的所有业务方法，再检查这些方法是否访问了目标属性。
• 这个方案能和你现有的Swagger解析脚本结合，做成一个自动化工具。

额外小建议 #

• 先明确"使用该属性执行业务逻辑"的具体场景：是读取属性值用于计算？还是修改属性值？不同场景的代码分析判断逻辑可以更精准。
• 如果项目用了依赖注入，可以扫描DI容器中的所有服务，先找出用到目标属性的服务方法，再反向找调用这些服务的API Action。

内容的提问来源于stack exchange，提问作者Rahul Bhosale