FastEndpoints项目中的Swagger标签大小写与分组优化指南

在FastEndpoints项目中，开发者有时会遇到Swagger文档中端点重复显示的问题。本文将从技术原理和解决方案两个维度，深入分析该问题的成因及最佳实践。

问题现象分析

当开发者尝试通过[Tags]属性手动修改端点分组时，可能会出现同一个API在Swagger文档中重复显示的情况。这是因为FastEndpoints框架本身已内置了自动分组机制，额外添加的标签属性会导致系统识别为两个不同的端点组。

核心解决方案

FastEndpoints提供了更优雅的配置方式来处理标签命名规范：

.SwaggerDocument(o => {
    o.TagCase = TagCase.TitleCase;  // 将标签转为首字母大写
    // 或
    o.TagCase = TagCase.None;      // 保持原始大小写
});

高级配置技巧

自v5.22.0.6-beta版本起，框架新增了更强大的路径处理能力：

bld.Services.SwaggerDocument(o => {
    o.AutoTagPathSegmentIndex = 2;    // 从路径第2段提取标签
    o.TagCase = TagCase.TitleCase;    // 转为标题格式
    o.TagStripSymbols = true;        // 移除分隔符号
});

这种配置可以智能处理包含特殊符号的路径，例如：

• 原始路径：/api/admin-dashboard/ticket/{id}
• 处理后标签：AdminDashboard

最佳实践建议

1. 避免直接使用[Tags]属性，优先使用框架提供的配置方式
2. 对于复杂路径命名，推荐启用TagStripSymbols选项
3. 保持整个项目的标签命名风格一致
4. 合理设置AutoTagPathSegmentIndex以匹配项目路由结构

通过理解这些配置选项，开发者可以更灵活地控制Swagger文档的组织结构，提升API文档的可读性和一致性。FastEndpoints的这些设计既考虑了开发便利性，也保持了足够的灵活性，是构建整洁API文档的有力工具。