API设计指南总结--命名规则（使用与REST API和RPC API）

参考goodle设计指南方针-----https://cloud.google.com/apis/design/resources

API中使用的所有名称都应该具备以下特点：

• 简单
• 直观
• 一致

产品名称

指API的产品营销名称。经过团队的认可即可。

例如：

Google Calendar API

服务名称

在语法上有效的DNS名称，可以解析为一个或多个网络地址。

例如:

calendar.googleapis.com

软件包名称

使用单数组件名称，不能使用下划线。进行版本控制的API软件包名称必须以此版本结尾。

例如：

google.calendar.v3

集合ID

采用复数和小驼峰式命名法格式，并遵循美式英语拼写和语义。

例如：

events、children或deleteEvents

接口名称

应该使用直观的名词。

例如:

pubsub.googleapis.com

方法名称

方法名称应采用大驼峰式命名格式并遵循VerbNoun（动名词组合），动词部分用于要求或者命令的祈使语气。不能包含介词。

例如:

ListBooks、GetBook

消息名称

比较简洁明了，也不包含介词。

枚举名称

枚举格式应该全部为大写，并且用‘_’分割

例如:

FIRST_VALUE

字段名称

字段名称应该全部为小写，并且用‘_’分割，不应使用后置形容词，对于API中重复的字段必须使用正确的复数形式。

例如：

failure_time_cpu_usage