包含REST的类的命名约定

Question

我们的新团队用API后缀类名来表示它们封装了RESTful方法。例如："PaymentTemplateAPI"，"FeeTemplateAPI“类。我觉得很奇怪，因为API是一个通用术语，指使用任何体系结构样式(REST、RPC等)创建的任何API/方法。我建议添加后缀"RestAPI“来表示类包含REST方法，或者根本不添加它。我只投后一票。如果用"API“后缀RESTful类名是一种标准做法的话，那就太好了。请分享你的想法。

虽然这个问题可能仍是以意见为本，但我想收集其他人的意见，以说服自己。

更新

该约定背后的原因之一是要区分实体和API接口。例如，我们为资源提供了一个PaymentTemplate模型/实体数据类，并为接口中的资源(PaymentTemplateAPI)定义了REST。我认为接口可以重命名为更有意义的PaymentTemplateAccessor/PaymentTemplateReader/PaymentTemplateWriter/PaymentTemplateDAO等等，我不认为这是原因。

Answer 1

如果您使用支持名称空间的编程语言(大多数流行的OO语言都支持名称空间)，那么在库的每个类中添加某个后缀是没有意义的，因为在名称空间本身中可以更好地设置后缀。这简直是多余的。

但是，如果需要使用某个后缀来区分一个库中的相关类和一个名称空间中的相关类，那么任何后缀都会很好地理解并为您的团队所接受--无论后缀是"API“、"RestAPI”还是“访问器”(或者其他什么)，都不会有太大的区别，只需让团队选择一个约定并始终如一地坚持下去( @Robert已经在一条评论中写道)。