how to design a good api and why it matters

简介: http://www.open-open.com/doc/view/ceee1d75382f4bbc93c8a8a2a98b4e52 Characteristics of a Good API• Easy to learn• Easy to use, even without documen...

http://www.open-open.com/doc/view/ceee1d75382f4bbc93c8a8a2a98b4e52

 

Characteristics of a Good API

• Easy to learn

• Easy to use, even without documentation

• Hard to misuse

• Easy to read and maintain code that uses it

• Sufficiently powerful to satisfy requirements

• Easy to extend

• Appropriate to audience

 

General Principles

API Should Do One Thing and Do it Well

API Should Be As Small As Possible But No Smaller

Implementation Should Not Impact API

Minimize Accessibility of Everything

Names Matter–API is a Little Language

Documentation Matters

Effects of API Design Decisions on Performance are Real and Permanent

API Must Coexist Peacefully with Platform

 

目录
相关文章
|
7月前
|
JavaScript API 开发工具
SAP Marketing Cloud Restful API SDK 使用案例分享
SAP Marketing Cloud Restful API SDK 使用案例分享
66 0
|
6月前
|
API
什么是 SAP Commerce Cloud SmartEdit 的 preview API
什么是 SAP Commerce Cloud SmartEdit 的 preview API
42 0
|
10月前
|
安全 Unix Shell
读书笔记系列 - Operating Systems: Three Easy Pieces - Virtualization - Chapter 5: Process API
读书笔记系列 - Operating Systems: Three Easy Pieces - Virtualization - Chapter 5: Process API
68 0
|
IDE Java API
REST Assured API Automation Testing Ⅰ - Getting Started
REST Assured API Automation Testing Ⅰ - Getting Started
REST Assured API Automation Testing Ⅰ - Getting Started
|
JavaScript 前端开发 jenkins
Postman for API Automation Testing Ⅰ
Postman for API Automation Testing Ⅰ
Postman for API Automation Testing Ⅰ
|
JavaScript API 开发工具
SAP Marketing Cloud Restful API SDK 使用案例分享(二)
SAP Marketing Cloud Restful API SDK 使用案例分享
82 0
SAP Marketing Cloud Restful API SDK 使用案例分享(二)
|
JavaScript API 开发工具
SAP Marketing Cloud Restful API SDK 使用案例分享(一)
SAP Marketing Cloud Restful API SDK 使用案例分享
567 1
SAP Marketing Cloud Restful API SDK 使用案例分享(一)
SAP Spartacus 使用 customized API
SAP Spartacus 使用 customized API
101 0
SAP Spartacus 使用 customized API
SAP Cloud for Customer用ABSL消费Restful Mashup API
SAP Cloud for Customer用ABSL消费Restful Mashup API
SAP Cloud for Customer用ABSL消费Restful Mashup API
如何通过Restful API的方式读取SAP Commerce Cloud的Product Reference
如何通过Restful API的方式读取SAP Commerce Cloud的Product Reference
如何通过Restful API的方式读取SAP Commerce Cloud的Product Reference