WebApi:Web API控制器方法的命名约定



我正在搜索Web API控制器方法的命名约定标准。

注意,我搜索的不是web API路由命名约定,而是web API控制器方法名称。

我的具体问题是,如果我有一个具有明确指定的HttpGet属性的控制器方法,那么我应该以单词Get开头它的名称吗?

例如,我应该将带有GET谓词的控制器方法命名为GetUserAddress还是仅命名为UserAddress,因为谓词已经表示它是一个get方法?

我搜索了很多帖子,但所有帖子都谈到了路由命名约定,而不是控制器的方法命名约定

我发现了一个这样的帖子,但无法在中得到我的答案

Web API 2 中的方法名称约定

编辑

这给出了一些答案,但我仍然不清楚我的具体问题

https://learn.microsoft.com/en-us/aspnet/web-api/overview/older-versions/creating-a-web-api-that-supports-crud-operations#getting-a资源

web API控制器方法的命名约定与任何类中的其他方法一样。它必须遵守所有的命名约定规则,正如鲍勃叔叔在他的书《干净代码命名约定》中提到的那样。

如果方法名称遵守这些规则,那就没问题了。微软添加了前缀";获取"在命名方面,尽管在另一方面一些开发人员使用前缀";加载";或";获取";

结论:如果命名方法尊重命名规则,就不必担心。

最新更新