什么是好的API设计?(转)

简介:

什么是API?

我们只要是在进行编程我们就需要不停的设计API。

API简单来讲可以是一个调用的函数,一个接口。

抽象来说,接口是一个内聚系统暴漏给外部的一切信息,包含但不限于:

调用方式:比如通过lib库或者http接口等。

调用约定:比如lib的函数签名或者HTTP的参数,http method或者头信息,长短链接等等。

依赖关系:比如接口的调用需要涉及到第三方或者其他的准备工作等等。

API就像一个人一样,我们和一个API打交道的时候需要了解这个人的特性偏好等,有的人很好相处,而有的人让人很头疼,尤其是你不得不和他打交道的时候,和人一样,如果你不得不和他打交道,要改变他的秉性是很痛苦的,人的“本性难移”, API也一样,一旦发布了,要改变的成本就很大很大。

好的API应该具有:

易于学习:即使没有文档也易于使用。

不易误用:这一点很重要,要减少使用者的心智负担。

易于满足需求:API的完备性和正交性。能够容易的满足需求,完备性保证功能完整,正交性保证接口的简洁性,不需要为所有的需求提供接口,而是由用户去组合。

易于扩展性

怎么样设计良好的API?

专一:一个API的功能应该是单一的,需要能够很容易的解释和理解,也就会更好用。

尽可能的小:小有很多的优势,易于理解和维护。

尽量少的外部依赖:减少使用者的成本。

设计不被实现影响:不要暴漏实现细节给用户,竟可能少的暴露,不止是内部细节,对于不必要的接口尽量不要发布,比如使用不多的功能,可以暂时不暴露接口。

良好的命名:尽量做到自描述。

完善的文档

考虑性能

 

转自:链接


本文转自SharkBin博客园博客,原文链接:http://www.cnblogs.com/SharkBin/p/5081746.html,如需转载请自行联系原作者


相关文章
|
XML JSON 前端开发
软件测试|Spring Boot 的 RESTful API 设计与实现
软件测试|Spring Boot 的 RESTful API 设计与实现
144 0
软件测试|Spring Boot 的 RESTful API 设计与实现
|
SQL 安全 Java
微服务API开放授权平台的设计与实现
微服务API开放授权平台的设计与实现
微服务API开放授权平台的设计与实现
|
XML SQL JSON
RESTful API 设计指南
RESTful API 设计指南
288 0
RESTful API 设计指南
|
API 微服务 Java
Netflix 实用 API 设计 (下)
Netflix 实用 API 设计 (下)
252 0
Netflix 实用 API 设计 (下)
|
消息中间件 JSON 缓存
如何设计 API 接口,实现统一格式返回?
如何设计 API 接口,实现统一格式返回?
如何设计 API 接口,实现统一格式返回?
|
算法 前端开发 安全
SpringCloud Gateway API接口安全设计(加密 、签名、安全)(一)
SpringCloud Gateway API接口安全设计(加密 、签名、安全)(一)
SpringCloud Gateway API接口安全设计(加密 、签名、安全)(一)
|
JSON 监控 安全
22条API设计的最佳实践
22条API设计的最佳实践
22条API设计的最佳实践
|
分布式计算 安全 API
异步 API 设计之扇入扇出模式
扇出/扇入模式是更高级 API 集成的主要内容。这些应用程序并不总是表现出相同的可用性或性能特征。
异步 API 设计之扇入扇出模式
|
存储 前端开发 Java
一文概览设计Web API 中的细节
一文概览设计Web API 中的细节
181 0
|
JSON 监控 API
22 条 API 设计最佳实践,快收藏。。(1)
22 条 API 设计最佳实践,快收藏。。(1)
147 0
22 条 API 设计最佳实践,快收藏。。(1)