Discoverable in API Design

简介: Avoiding the use of abbreviations can also play a factor in discoverability for API design. 可探索的API就是用户自己可以知道怎样使用API而不需要任何附加解释或文档。

Avoiding the use of abbreviations can also play a factor in discoverability for API design.

可探索的API就是用户自己可以知道怎样使用API而不需要任何附加解释或文档。有些方法可以在你设计API时提高API的可探索性。设计一个直观和逻辑性强的对象模型是一个重要方式,因为为类和函数选择了好的名字。不过,取一个清晰、达意及合适的名字确实是API设计中最困难的任务啦。我在第4章中推荐了几种方法,但避免使用缩写在提高API的可探索性中也是一个重要因素,这样用户就不需要记住你的API是使用GetCurrentValue(), GetCurrValue(), GetCurValue(), 还是GetCurVal()啦。这一点深有体会,有时想缩写来减少敲键盘的次数,但缩写后也是会有对API的使用区分不清楚的时候。最好是做好数据字典,在API中全部使用全称,这样就舒服啦。

目录
相关文章
|
1月前
|
JavaScript API
Composition Api 与 Options Api 有什么区别?
Composition Api 与 Options Api 有什么区别?
16 0
|
8月前
|
JavaScript API 开发工具
SAP Marketing Cloud Restful API SDK 使用案例分享
SAP Marketing Cloud Restful API SDK 使用案例分享
68 0
|
6月前
|
JavaScript 安全 API
Composition API的引入
Composition API的引入
25 0
|
7月前
|
XML 安全 API
Rest API 开发分享
Rest API 开发分享
|
JavaScript API 开发工具
SAP Marketing Cloud Restful API SDK 使用案例分享(二)
SAP Marketing Cloud Restful API SDK 使用案例分享
86 0
SAP Marketing Cloud Restful API SDK 使用案例分享(二)
|
JavaScript API 开发工具
SAP Marketing Cloud Restful API SDK 使用案例分享(一)
SAP Marketing Cloud Restful API SDK 使用案例分享
568 1
SAP Marketing Cloud Restful API SDK 使用案例分享(一)
|
API 网络架构
SAP API Business Hub 上测试 API 的一些常见问题
SAP API Business Hub 上测试 API 的一些常见问题
130 0
SAP API Business Hub 上测试 API 的一些常见问题
SAP Spartacus 使用 customized API
SAP Spartacus 使用 customized API
101 0
SAP Spartacus 使用 customized API
SAP Spartacus 里 对 isPlatformBrowser API 的使用
window-ref.ts 里的 isBrowser API,封装的是 Angular 标准 API,isPlatformBrowser:
SAP Spartacus 里 对 isPlatformBrowser API 的使用