You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

FastEndpoints下RESTful用户端点的命名与文件夹结构规划咨询

针对FastEndpoints多GET用户端点的命名与文件夹结构方案

针对你遇到的多个用户相关GET端点重名问题,推荐两种实用的策略,既符合FastEndpoints的使用习惯,也能让代码结构清晰易维护:

策略一:按资源细化子文件夹+功能明确的文件名

在原有的Endpoints/GET目录下,新增Users子文件夹,然后按端点功能命名文件,结构如下:

Endpoints/
└── GET/
    └── Users/
        ├── GetAllUsers.cs
        ├── GetUserById.cs
        └── GetUsersByFilter.cs

对应的端点类命名也要和文件名保持一致:

  • GetAllUsers类:配置路由[HttpGet("/Users")],实现获取所有用户逻辑
  • GetUserById类:配置路由[HttpGet("/Users/{Id}")],实现单个用户查询逻辑
  • GetUsersByFilter类:配置路由[HttpGet("/Users/Filter/{filter}")],实现筛选查询逻辑

这种方式把同一资源(用户)的所有GET操作归类到子文件夹,文件名直接体现功能,团队协作时一眼就能定位到对应端点。

策略二:扁平化结构+带功能前缀的文件名

如果不想嵌套太多子文件夹,直接在Endpoints/GET目录下用「资源名_功能名」的规则命名文件,结构如下:

Endpoints/
└── GET/
    ├── Users_GetAll.cs
    ├── Users_GetById.cs
    └── Users_GetByFilter.cs

对应的端点类命名为Users_GetAllEndpoint、Users_GetByIdEndpoint、Users_GetByFilterEndpoint,路由配置和上面一致。

这种方式保持了目录的扁平化,同时通过文件名前缀区分资源,后缀明确功能,避免重名的同时也能快速识别端点作用。

额外建议

  • 不管用哪种策略,都要保证类名和文件名一致,符合C#项目的常规命名规范
  • 端点类内部的路由配置要和文件名/类名的功能对应,避免出现路由和功能不匹配的情况
  • 如果后续还有其他用户相关的HTTP方法(比如POST、PUT),可以参照这个逻辑,在Endpoints下新增POST/Users、PUT/Users等子目录,保持整体结构的一致性

内容的提问来源于stack exchange,提问作者PassionateDeveloper

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.06.23 17:22:38