知方号

知方号

命名约定<后端接口命名规范>

命名约定

命名约定产品名称服务名称包名称集合标识符接口名称方法名称消息名称枚举名称字段名称重复字段名称瞬时时间和持续时间日期和时刻数量列表过滤器字段列表响应驼峰体名称缩写命名约定

为了在跨API开发中向开发者提供一致的开发体验,所有的命名应该保证:

简单直观一致

这适用于接口、资源、集合、方法以及消息的命名。

因为很多开发者并非以英语作为母语,所以命名约定的目标之一是确保大多数开发者可以更容易理解 API。对于方法和资源,我们鼓励使用简单、直观和一致的单词来命名。

API 中的命名应该使用正确的美式英语。例如,使用美式英语的 license 而非英式英语的 licence;使用美式英语的 color 而非英式英语的 colour为了简化起见,可以使用已被广泛接受的短语和(或)缩写。例如,使用 API 比Application Programming Interface更好尽量使用直观、熟悉的术语。例如,描述移除(removing)或销毁(destroying)一个资源时,使用删除(delete)比擦除(erase)更好为了避免歧义,对于同一种概念应当使用相同的名称或短语,这一点适用于跨越多个不同API的概念为了避免歧义,对于不同的概念应当使用不同的名称或短语为了避免在 API 的上下文以及更大的 Google API 生态系统中存在含糊不清和过于笼统的名称(它们可能导致对 API 概念的误解)。应当选择能准确描述 API 概念的名称,这对定义 API 中的资源名称特别重要。应当仔细思考那些可能与常用编程语言中关键字冲突的名称。产品名称

产品名称应当参考那些API的公开产品名称,例如 Google Calendar API。同时,在API、用户界面、文档、服务协议、收费

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至lizi9903@foxmail.com举报,一经查实,本站将立刻删除。