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中全部使用全称,这样就舒服啦。

目录
相关文章
|
7月前
|
开发框架 监控 .NET
Visual Basic的Web服务和REST API开发指南
【4月更文挑战第27天】本文探讨了使用Visual Basic(VB.NET)构建Web服务和RESTful API的方法。首先介绍了Web服务的基础和REST API的概念,然后阐述了.NET Framework与.NET Core/.NET 5+对VB.NET的支持,以及ASP.NET Core在Web开发中的作用。接着,详细讲解了创建RESTful API的步骤,包括控制器与路由设置、模型绑定与验证,以及返回响应。此外,还讨论了安全措施、测试方法、部署选项和监控策略。最后强调,VB.NET开发者可以通过ASP.NET Core涉足现代Web服务开发,拓宽技术领域。
276 1
|
3月前
|
JSON 中间件 API
开发REST API3-11
开发REST API3-11
|
4月前
|
JavaScript 编译器 API
什么是Composition API
【8月更文挑战第16天】什么是Composition API
336 2
|
7月前
|
JavaScript API
Composition Api 与 Options Api 有什么区别?
Composition Api 与 Options Api 有什么区别?
138 0
|
XML 安全 API
Rest API 开发分享
Rest API 开发分享
|
XML 存储 SQL
REST API 设计规范(上)
REST API 设计规范
250 0
|
SQL 搜索推荐 Java
REST API 设计规范(下)
REST API 设计规范(下)
219 0
|
前端开发 API C++
Dart API 扩展
Dart VM 里面其实提供了 dart 跟 cpp 之间的相互调用接口,开发者可以基于这个接口自行扩展 dart 的 api, 本文描述了如何方便的扩展,介绍了 Dart 和 Cpp 直接调用的基本使用方法。
3266 0
|
NoSQL 前端开发 API
Nancy之实现API的功能
原文:Nancy之实现API的功能 0x01、前言 现阶段,用来实现API的可能大部分用的是ASP.NET Web API或者是ASP.NET MVC,毕竟是微软官方出产的,用的人也多。 但是呢,NancyFx也是一个很不错的选择。
1036 0
|
API
UWP Composition API - GroupListView(二)
原文:UWP Composition API - GroupListView(二) 还是先上效果图: 看完了上一篇UWP Composition API - GroupListView(一)的童鞋会问,这不是跟上一篇一样的吗??? 骗点击的?? No,No,其实相对上一个有更简单粗暴的方案,因为上篇是为了研究Composition API,所以含着泪都要做完(有没有被骗的赶脚)。
1290 0