FastEndpoints中默认路由与分组路由的配置技巧

在使用FastEndpoints框架开发API时，开发者经常会遇到需要将多个端点(Endpoint)组织到同一个路由分组中的场景。本文深入探讨了如何正确配置分组路由与默认路由，以及相关的最佳实践。

分组路由的基本配置

FastEndpoints提供了Group特性来帮助开发者组织路由结构。典型的分组配置方式如下：

sealed class MyGroup : Group
{
    public MyGroup()
    {
        Configure("/api/my-feature", _ => { });
    }
}

这种配置方式明确地定义了分组的基础路径"/api/my-feature"，使得组内所有端点都能共享这个前缀。

默认路由的特殊处理

当我们需要在分组中配置一个默认路由(即直接响应分组基础路径的端点)时，需要注意以下细节：

sealed class MyEndpoint : Ep.NoReq.NoRes
{
    public override void Configure()
    {
        Get("/");  // 显式指定根路径
        Group<MyGroup>();
    }
}

这里的关键点是必须显式指定路径为"/"，而不是使用空字符串或省略参数。这种做法的优势在于：

1. 代码可读性更强，明确表示了这是一个根路径端点
2. 符合RESTful API设计原则，使路由意图更加清晰
3. 避免因隐式行为导致的维护困难

框架的优化与改进

在早期版本中，使用空字符串或"/"作为路径时，Swagger UI会显示带有尾部斜杠的路径，这在视觉上不够优雅。FastEndpoints团队在v5.30.0.22-beta版本中修复了这个问题，使得API文档展示更加整洁。

最佳实践建议

1. 显式优于隐式：总是明确指定路由路径，即使它是根路径
2. 保持一致性：在整个项目中统一使用"/"或""表示根路径
3. 文档友好：考虑生成的API文档的可读性
4. 版本控制：及时更新框架版本以获取最佳体验

通过遵循这些实践，开发者可以构建出结构清晰、易于维护的API路由体系，同时提供良好的开发者体验。