ServiceStack AutoQuery Code First模式自定义CRUD接口不显示问题

为什么自定义AutoQuery CRUD接口在API Explorer不显示？ #

你可能遗漏了以下几个关键环节：

• 请求DTO未正确关联AutoQuery的CRUD契约
  自定义的CRUD请求DTO必须明确继承ServiceStack AutoQuery的专用基类或实现对应接口，ServiceStack才能识别它们属于AutoQuery CRUD范畴：

  • 查询类（如QueryDropPositions）需继承AutoQueryDb<DropPosition>或实现IQueryDb<DropPosition>
  • 创建类（如CreateDropPosition）需继承CreateDb<DropPosition>或实现ICreateDb<DropPosition>
  • 更新/删除类同理，分别对应UpdateDb<DropPosition>/IUpdateDb<DropPosition>、DeleteDb<DropPosition>/IDeleteDb<DropPosition>

• 请求DTO所在程序集未被AppHost扫描
  如果自定义请求DTO在独立类库或Web项目的特定命名空间下，必须在AppHost的Configure方法中显式添加该程序集的扫描逻辑，确保ServiceStack能发现这些DTO：

  public override void Configure(Container container)
  {
      // 注册包含自定义请求DTO的程序集
      AddAssembly(typeof(QueryDropPositions).Assembly);
      
      // 启用AutoQuery，注意关闭自动生成服务
      Plugins.Add(new AutoQueryFeature {
          GenerateCrudServices = false
      });
  }
  

• 未给请求DTO添加路由属性
  虽然AutoQuery会默认生成路由，但显式添加[Route]属性能确保API Explorer正确识别并展示接口，也支持自定义路由路径：

  [Route("/drop-positions", "GET")]
  public class QueryDropPositions : AutoQueryDb<DropPosition> {}
  
  [Route("/drop-positions", "POST")]
  public class CreateDropPosition : CreateDb<DropPosition>
  {
      // 可在此添加自定义参数或验证规则
  }
  

如何仅使用自定义的AutoQuery CRUD API？ #

按以下配置即可实现：

1. 彻底关闭自动生成CRUD服务
   启用AutoQueryFeature时必须设置GenerateCrudServices = false，阻止ServiceStack自动生成基于POCO的默认CRUD接口。

2. 确保自定义请求DTO被正确识别
   所有自定义CRUD请求DTO都要关联到你的DropPosition POCO，且所在程序集已被AppHost扫描到，参考上面的代码示例。

3. 可选：添加API注解优化Explorer展示
   使用[Api]和[ApiMember]注解给接口添加描述，让API Explorer的信息更清晰：

   [Api("查询DropPosition记录，支持按状态筛选")]
   [Route("/drop-positions", "GET")]
   public class QueryDropPositions : AutoQueryDb<DropPosition>
   {
       [ApiMember(Name = "Status", Description = "筛选状态值", ParameterType = "query")]
       public int? Status { get; set; }
   }
   

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