什么是好的API设计？

mudiyouyou 发布于2019-06-27 14:14 / 2805人阅读

摘要：什么是我们只要是在进行编程我们就需要不停的设计。不易误用这一点很重要，要减少使用者的心智负担。尽量少的外部依赖减少使用者的成本。良好的命名尽量做到自描述。

什么是API？

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

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

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

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

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

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

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

好的API应该具有：

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

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

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

易于扩展性

怎么样设计良好的API？

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

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

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

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

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

完善的文档

考虑性能

Thanks ~

AD:

服务器托管混合云什么是好域名好的网站设计公司 api设计比较好的网站设计

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/21877.html

一篇文章了解Js Bridge

摘要：安全安全是很重要的，现在有些实现中使用了，而在之前，存在任意代码执行漏洞，这就会导致严重的安全问题。 showImg(https://segmentfault.com/img/bV4k9Q?w=719&h=372); 什么是JS Bridge 在大多数APP开发过程中，都会通过H5来实现部分功能，而Hybird APP基本90%以上都是H5。现在很少有纯原生的APP。但是，由于H5页面...

Karuru 2019-08-22 14:54 评论0 收藏0
一篇文章了解Js Bridge

摘要：安全安全是很重要的，现在有些实现中使用了，而在之前，存在任意代码执行漏洞，这就会导致严重的安全问题。 showImg(https://segmentfault.com/img/bV4k9Q?w=719&h=372); 什么是JS Bridge 在大多数APP开发过程中，都会通过H5来实现部分功能，而Hybird APP基本90%以上都是H5。现在很少有纯原生的APP。但是，由于H5页面...

ruicbAndroid 2019-06-25 16:41 评论0 收藏0
JavaScript文章

摘要：我对知乎前端相关问题的十问十答张鑫旭张鑫旭大神对知乎上经典的个前端问题的回答。作者对如何避免常见的错误，难以发现的问题，以及性能问题和不好的实践给出了相应的建议。但并不是本身有问题，被标准定义的是极好的。这一次，彻底弄懂 JavaScript 执行机制本文的目的就是要保证你彻底弄懂javascript的执行机制，如果读完本文还不懂，可以揍我。不论你是javascript新手还是老...

mumumu 2019-08-22 13:50 评论0 收藏0
why nodejs

摘要：一个快速计算假设每个线程可能有一个伴随的内存，运行在具有的系统上，我们理论上最多有个并发连接，以及线程之间的上下文切换的成本。通过避免这一切，实现了超过个并发连接的可伸缩性级别作为概念验证。通过近期的面试，我认识到自己的学习方法还是有问题，面百度的时候面试官问我，为什么要用node，为什么不用php，对于只学过node几天的我当时就楞了，大概想到单线程事件轮询和多线程，后来面试官告诉...

wujl596 2019-08-22 10:40 评论0 收藏0
《从零构建前后分离web项目》探究 - 深入聊聊前后分离架构

摘要：什么是前后分离前后端分离并不是什么新鲜事，到处都是前后端分离的实践。然而一些历史项目在从一体化设计转向前后端分离的架构时，不可避免的会遇到各种各样的问题。搞了一个前后分离，需要分离部署。探究：深入聊聊前后分离架构前后分离，一直是一个相当泛泛的问题，前后分离到底好不好？没有绝对的对，没有绝对的错，业界就这个问题已经激烈的探讨几年了.出现讨论的点在于：分离当然是好的,但是以什么样的服...

whinc 2019-08-23 11:44 评论0 收藏0